Skip to main content
API docs by Redocly

ChannelApe API

Download OpenAPI specification:Download

Introspection

OpenAPI description (this document)

Responses

order_line_items

A line item in an order

query Parameters
id
string <uuid>
business_id
string <uuid>
order_id
string <uuid>

The order the line item belongs to.

inventory_item_id
string <uuid>

The inventory item the line item belongs to.

quantity
string <integer>

The quantity of the line item.

additional_fields
string <jsonb>
external_ids
string <jsonb>
upc
string <text>

The upc of the line item.

vendor
string <text>

The vendor of the line item.

grams
string <numeric>

The weight of the line item in grams.

price
string <integer>

The price of the line item.

shipping_method
string <text>

The shipping method of the line item.

shipping_price
string <integer>

The shipping price of the line item.

shipping_tax
string <integer>

The shipping tax of the line item.

presale_quantity
string <integer>

The presale quantity of the line item.

reserve_quantity
string <integer>

The reserve quantity of the line item.

select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

A line item in an order

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

order_line_items

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

order_id
required
string <uuid>

The order the line item belongs to.

inventory_item_id
string <uuid>

The inventory item the line item belongs to.

quantity
required
integer <integer>

The quantity of the line item.

additional_fields
any <jsonb>
external_ids
any <jsonb>
upc
string <text>

The upc of the line item.

vendor
string <text>

The vendor of the line item.

grams
number <numeric>

The weight of the line item in grams.

price
integer <integer>

The price of the line item.

shipping_method
string <text>

The shipping method of the line item.

shipping_price
integer <integer>

The shipping price of the line item.

shipping_tax
integer <integer>

The shipping tax of the line item.

presale_quantity
integer <integer>

The presale quantity of the line item.

reserve_quantity
integer <integer>

The reserve quantity of the line item.

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
  • "quantity": 0,
  • "additional_fields": null,
  • "external_ids": null,
  • "upc": "string",
  • "vendor": "string",
  • "grams": 0,
  • "price": 0,
  • "shipping_method": "string",
  • "shipping_price": 0,
  • "shipping_tax": 0,
  • "presale_quantity": 0,
  • "reserve_quantity": 0
}

A line item in an order

query Parameters
id
string <uuid>
business_id
string <uuid>
order_id
string <uuid>

The order the line item belongs to.

inventory_item_id
string <uuid>

The inventory item the line item belongs to.

quantity
string <integer>

The quantity of the line item.

additional_fields
string <jsonb>
external_ids
string <jsonb>
upc
string <text>

The upc of the line item.

vendor
string <text>

The vendor of the line item.

grams
string <numeric>

The weight of the line item in grams.

price
string <integer>

The price of the line item.

shipping_method
string <text>

The shipping method of the line item.

shipping_price
string <integer>

The shipping price of the line item.

shipping_tax
string <integer>

The shipping tax of the line item.

presale_quantity
string <integer>

The presale quantity of the line item.

reserve_quantity
string <integer>

The reserve quantity of the line item.

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A line item in an order

query Parameters
id
string <uuid>
business_id
string <uuid>
order_id
string <uuid>

The order the line item belongs to.

inventory_item_id
string <uuid>

The inventory item the line item belongs to.

quantity
string <integer>

The quantity of the line item.

additional_fields
string <jsonb>
external_ids
string <jsonb>
upc
string <text>

The upc of the line item.

vendor
string <text>

The vendor of the line item.

grams
string <numeric>

The weight of the line item in grams.

price
string <integer>

The price of the line item.

shipping_method
string <text>

The shipping method of the line item.

shipping_price
string <integer>

The shipping price of the line item.

shipping_tax
string <integer>

The shipping tax of the line item.

presale_quantity
string <integer>

The presale quantity of the line item.

reserve_quantity
string <integer>

The reserve quantity of the line item.

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

order_line_items

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

order_id
required
string <uuid>

The order the line item belongs to.

inventory_item_id
string <uuid>

The inventory item the line item belongs to.

quantity
required
integer <integer>

The quantity of the line item.

additional_fields
any <jsonb>
external_ids
any <jsonb>
upc
string <text>

The upc of the line item.

vendor
string <text>

The vendor of the line item.

grams
number <numeric>

The weight of the line item in grams.

price
integer <integer>

The price of the line item.

shipping_method
string <text>

The shipping method of the line item.

shipping_price
integer <integer>

The shipping price of the line item.

shipping_tax
integer <integer>

The shipping tax of the line item.

presale_quantity
integer <integer>

The presale quantity of the line item.

reserve_quantity
integer <integer>

The reserve quantity of the line item.

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
  • "quantity": 0,
  • "additional_fields": null,
  • "external_ids": null,
  • "upc": "string",
  • "vendor": "string",
  • "grams": 0,
  • "price": 0,
  • "shipping_method": "string",
  • "shipping_price": 0,
  • "shipping_tax": 0,
  • "presale_quantity": 0,
  • "reserve_quantity": 0
}

product_variant_options

The options that a product variant has

query Parameters
id
string <uuid>

A generated product variant option ID

product_variant_id
string <uuid>

The product variant that the option belongs to

name
string <public.short_text>

The name of the option

value
string <public.short_text>

The value of the option

ordinal
string <integer>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

The options that a product variant has

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

product_variant_options

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

A generated product variant option ID

Note: This is a Primary Key.

product_variant_id
required
string <uuid>

The product variant that the option belongs to

Note: This is a Foreign Key to product_variants.id.

name
required
string <public.short_text>

The name of the option

value
required
string <public.short_text>

The value of the option

ordinal
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
  • "name": "string",
  • "value": "string",
  • "ordinal": 0
}

The options that a product variant has

query Parameters
id
string <uuid>

A generated product variant option ID

product_variant_id
string <uuid>

The product variant that the option belongs to

name
string <public.short_text>

The name of the option

value
string <public.short_text>

The value of the option

ordinal
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

The options that a product variant has

query Parameters
id
string <uuid>

A generated product variant option ID

product_variant_id
string <uuid>

The product variant that the option belongs to

name
string <public.short_text>

The name of the option

value
string <public.short_text>

The value of the option

ordinal
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

product_variant_options

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

A generated product variant option ID

Note: This is a Primary Key.

product_variant_id
required
string <uuid>

The product variant that the option belongs to

Note: This is a Foreign Key to product_variants.id.

name
required
string <public.short_text>

The name of the option

value
required
string <public.short_text>

The value of the option

ordinal
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
  • "name": "string",
  • "value": "string",
  • "ordinal": 0
}

webhook_configurations

/webhook_configurations

query Parameters
id
string <uuid>
business_id
string <uuid>
hook_producer_url
string <text>
hook_consumer_url
string <text>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/webhook_configurations

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

webhook_configurations

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

hook_producer_url
string <text>
Default: "NULL"
hook_consumer_url
required
string <text>
Default: "NULL"

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "hook_producer_url": "NULL",
  • "hook_consumer_url": "NULL"
}

/webhook_configurations

query Parameters
id
string <uuid>
business_id
string <uuid>
hook_producer_url
string <text>
hook_consumer_url
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/webhook_configurations

query Parameters
id
string <uuid>
business_id
string <uuid>
hook_producer_url
string <text>
hook_consumer_url
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

webhook_configurations

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

hook_producer_url
string <text>
Default: "NULL"
hook_consumer_url
required
string <text>
Default: "NULL"

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "hook_producer_url": "NULL",
  • "hook_consumer_url": "NULL"
}

channels

A channel is a way to receive orders, it can be a website, a marketplace, a POS, etc.

query Parameters
id
string <uuid>
business_id
string <uuid>
location_id
string <uuid>
name
string <text>

The name of the channel, must be unique for a business.

enabled
string <boolean>

Whether the channel is enabled or not.

additional_fields
string <jsonb>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

A channel is a way to receive orders, it can be a website, a marketplace, a POS, etc.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

channels

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

location_id
string <uuid>
name
required
string <text>

The name of the channel, must be unique for a business.

enabled
required
boolean <boolean>
Default: true

Whether the channel is enabled or not.

additional_fields
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "name": "string",
  • "enabled": true,
  • "additional_fields": null
}

A channel is a way to receive orders, it can be a website, a marketplace, a POS, etc.

query Parameters
id
string <uuid>
business_id
string <uuid>
location_id
string <uuid>
name
string <text>

The name of the channel, must be unique for a business.

enabled
string <boolean>

Whether the channel is enabled or not.

additional_fields
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A channel is a way to receive orders, it can be a website, a marketplace, a POS, etc.

query Parameters
id
string <uuid>
business_id
string <uuid>
location_id
string <uuid>
name
string <text>

The name of the channel, must be unique for a business.

enabled
string <boolean>

Whether the channel is enabled or not.

additional_fields
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

channels

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

location_id
string <uuid>
name
required
string <text>

The name of the channel, must be unique for a business.

enabled
required
boolean <boolean>
Default: true

Whether the channel is enabled or not.

additional_fields
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "name": "string",
  • "enabled": true,
  • "additional_fields": null
}

product_data

/product_data

query Parameters
jwt
string <text>
name
string <public.short_text>

Display name for the product

business_id
string <uuid>

Id of the Business this product belong to.

sku
string <public.short_text>

Product stock keeping unit, this may differ from your vendors sku.

cost
string <numeric>

Brands Landed cost. Landed cost IS the sum of ALL expenses associated WITH shipping goods TO their final destination

landed_cost
string <numeric>
price
string <numeric>

Brands retail price IN USD

wholesale_price
string <numeric>

Brands wholesale price IN USD

image
string <text>

External image url for the product, has to be in an http or https protocol.

hs_code
string <public.short_text>

Harmonized System Classification Number

length_mm
string <integer>

Length of the packaging IN millimeters

height_mm
string <integer>

Height of the packaging IN millimeters

width_mm
string <integer>

Width of the packaging IN millimeters

weight_grams
string <integer>

Weight of the product IN grams

is_active
string <boolean>

Is this product currently in use?

country_of_origin
string <public.short_text>
upc
string <text>

UPC Code

option_name_1
string <public.short_text>

Name of Option 1 Attribute

option_value_1
string <public.short_text>

Value of Option 1 Attribute

option_name_2
string <public.short_text>

Name of Option 2 Attribute

option_value_2
string <public.short_text>

Value of Option 2 Attribute

option_name_3
string <public.short_text>

Name of Option 3 Attribute

option_value_3
string <public.short_text>

Value of Option 3 Attribute

option_name_4
string <public.short_text>

Name of Option 4 Attribute

option_value_4
string <public.short_text>

Value of Option 4 Attribute

option_name_5
string <public.short_text>

Name of Option 5 Attribute

option_value_5
string <public.short_text>

Value of Option 5 Attribute

option_name_6
string <public.short_text>

Name of Option 6 Attribute

option_value_6
string <public.short_text>

Value of Option 6 Attribute

tags
string <text[]>

Used TO Group certain products together INTO collections

category_1
string <public.short_text>

The top-level category of the product used to structure products into a hierarchy

category_2
string <public.short_text>

A subcategory nested under category_1

category_3
string <public.short_text>

A subcategory nested under category_2

category_4
string <public.short_text>

A subcategory nested under category_3

category_5
string <public.short_text>

A subcategory nested under category_4

category_6
string <public.short_text>

A subcategory nested under category_5

select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/product_data

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

product_data

jwt
string <text>
name
string <public.short_text>

Display name for the product

business_id
string <uuid>

Id of the Business this product belong to.

sku
string <public.short_text>

Product stock keeping unit, this may differ from your vendors sku.

cost
number <numeric>

Brands Landed cost. Landed cost IS the sum of ALL expenses associated WITH shipping goods TO their final destination

landed_cost
number <numeric>
price
number <numeric>

Brands retail price IN USD

wholesale_price
number <numeric>

Brands wholesale price IN USD

image
string <text>

External image url for the product, has to be in an http or https protocol.

hs_code
string <public.short_text>

Harmonized System Classification Number

length_mm
integer <integer>

Length of the packaging IN millimeters

height_mm
integer <integer>

Height of the packaging IN millimeters

width_mm
integer <integer>

Width of the packaging IN millimeters

weight_grams
integer <integer>

Weight of the product IN grams

is_active
boolean <boolean>

Is this product currently in use?

country_of_origin
string <public.short_text>
upc
string <text>

UPC Code

option_name_1
string <public.short_text>

Name of Option 1 Attribute

option_value_1
string <public.short_text>

Value of Option 1 Attribute

option_name_2
string <public.short_text>

Name of Option 2 Attribute

option_value_2
string <public.short_text>

Value of Option 2 Attribute

option_name_3
string <public.short_text>

Name of Option 3 Attribute

option_value_3
string <public.short_text>

Value of Option 3 Attribute

option_name_4
string <public.short_text>

Name of Option 4 Attribute

option_value_4
string <public.short_text>

Value of Option 4 Attribute

option_name_5
string <public.short_text>

Name of Option 5 Attribute

option_value_5
string <public.short_text>

Value of Option 5 Attribute

option_name_6
string <public.short_text>

Name of Option 6 Attribute

option_value_6
string <public.short_text>

Value of Option 6 Attribute

tags
Array of strings

Used TO Group certain products together INTO collections

category_1
string <public.short_text>

The top-level category of the product used to structure products into a hierarchy

category_2
string <public.short_text>

A subcategory nested under category_1

category_3
string <public.short_text>

A subcategory nested under category_2

category_4
string <public.short_text>

A subcategory nested under category_3

category_5
string <public.short_text>

A subcategory nested under category_4

category_6
string <public.short_text>

A subcategory nested under category_5

Responses

Request samples

Content type
{
  • "jwt": "string",
  • "name": "string",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "sku": "string",
  • "cost": 0,
  • "landed_cost": 0,
  • "price": 0,
  • "wholesale_price": 0,
  • "image": "string",
  • "hs_code": "string",
  • "length_mm": 0,
  • "height_mm": 0,
  • "width_mm": 0,
  • "weight_grams": 0,
  • "is_active": true,
  • "country_of_origin": "string",
  • "upc": "string",
  • "option_name_1": "string",
  • "option_value_1": "string",
  • "option_name_2": "string",
  • "option_value_2": "string",
  • "option_name_3": "string",
  • "option_value_3": "string",
  • "option_name_4": "string",
  • "option_value_4": "string",
  • "option_name_5": "string",
  • "option_value_5": "string",
  • "option_name_6": "string",
  • "option_value_6": "string",
  • "tags": [
    ],
  • "category_1": "string",
  • "category_2": "string",
  • "category_3": "string",
  • "category_4": "string",
  • "category_5": "string",
  • "category_6": "string"
}

/product_data

query Parameters
jwt
string <text>
name
string <public.short_text>

Display name for the product

business_id
string <uuid>

Id of the Business this product belong to.

sku
string <public.short_text>

Product stock keeping unit, this may differ from your vendors sku.

cost
string <numeric>

Brands Landed cost. Landed cost IS the sum of ALL expenses associated WITH shipping goods TO their final destination

landed_cost
string <numeric>
price
string <numeric>

Brands retail price IN USD

wholesale_price
string <numeric>

Brands wholesale price IN USD

image
string <text>

External image url for the product, has to be in an http or https protocol.

hs_code
string <public.short_text>

Harmonized System Classification Number

length_mm
string <integer>

Length of the packaging IN millimeters

height_mm
string <integer>

Height of the packaging IN millimeters

width_mm
string <integer>

Width of the packaging IN millimeters

weight_grams
string <integer>

Weight of the product IN grams

is_active
string <boolean>

Is this product currently in use?

country_of_origin
string <public.short_text>
upc
string <text>

UPC Code

option_name_1
string <public.short_text>

Name of Option 1 Attribute

option_value_1
string <public.short_text>

Value of Option 1 Attribute

option_name_2
string <public.short_text>

Name of Option 2 Attribute

option_value_2
string <public.short_text>

Value of Option 2 Attribute

option_name_3
string <public.short_text>

Name of Option 3 Attribute

option_value_3
string <public.short_text>

Value of Option 3 Attribute

option_name_4
string <public.short_text>

Name of Option 4 Attribute

option_value_4
string <public.short_text>

Value of Option 4 Attribute

option_name_5
string <public.short_text>

Name of Option 5 Attribute

option_value_5
string <public.short_text>

Value of Option 5 Attribute

option_name_6
string <public.short_text>

Name of Option 6 Attribute

option_value_6
string <public.short_text>

Value of Option 6 Attribute

tags
string <text[]>

Used TO Group certain products together INTO collections

category_1
string <public.short_text>

The top-level category of the product used to structure products into a hierarchy

category_2
string <public.short_text>

A subcategory nested under category_1

category_3
string <public.short_text>

A subcategory nested under category_2

category_4
string <public.short_text>

A subcategory nested under category_3

category_5
string <public.short_text>

A subcategory nested under category_4

category_6
string <public.short_text>

A subcategory nested under category_5

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/product_data

query Parameters
jwt
string <text>
name
string <public.short_text>

Display name for the product

business_id
string <uuid>

Id of the Business this product belong to.

sku
string <public.short_text>

Product stock keeping unit, this may differ from your vendors sku.

cost
string <numeric>

Brands Landed cost. Landed cost IS the sum of ALL expenses associated WITH shipping goods TO their final destination

landed_cost
string <numeric>
price
string <numeric>

Brands retail price IN USD

wholesale_price
string <numeric>

Brands wholesale price IN USD

image
string <text>

External image url for the product, has to be in an http or https protocol.

hs_code
string <public.short_text>

Harmonized System Classification Number

length_mm
string <integer>

Length of the packaging IN millimeters

height_mm
string <integer>

Height of the packaging IN millimeters

width_mm
string <integer>

Width of the packaging IN millimeters

weight_grams
string <integer>

Weight of the product IN grams

is_active
string <boolean>

Is this product currently in use?

country_of_origin
string <public.short_text>
upc
string <text>

UPC Code

option_name_1
string <public.short_text>

Name of Option 1 Attribute

option_value_1
string <public.short_text>

Value of Option 1 Attribute

option_name_2
string <public.short_text>

Name of Option 2 Attribute

option_value_2
string <public.short_text>

Value of Option 2 Attribute

option_name_3
string <public.short_text>

Name of Option 3 Attribute

option_value_3
string <public.short_text>

Value of Option 3 Attribute

option_name_4
string <public.short_text>

Name of Option 4 Attribute

option_value_4
string <public.short_text>

Value of Option 4 Attribute

option_name_5
string <public.short_text>

Name of Option 5 Attribute

option_value_5
string <public.short_text>

Value of Option 5 Attribute

option_name_6
string <public.short_text>

Name of Option 6 Attribute

option_value_6
string <public.short_text>

Value of Option 6 Attribute

tags
string <text[]>

Used TO Group certain products together INTO collections

category_1
string <public.short_text>

The top-level category of the product used to structure products into a hierarchy

category_2
string <public.short_text>

A subcategory nested under category_1

category_3
string <public.short_text>

A subcategory nested under category_2

category_4
string <public.short_text>

A subcategory nested under category_3

category_5
string <public.short_text>

A subcategory nested under category_4

category_6
string <public.short_text>

A subcategory nested under category_5

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

product_data

jwt
string <text>
name
string <public.short_text>

Display name for the product

business_id
string <uuid>

Id of the Business this product belong to.

sku
string <public.short_text>

Product stock keeping unit, this may differ from your vendors sku.

cost
number <numeric>

Brands Landed cost. Landed cost IS the sum of ALL expenses associated WITH shipping goods TO their final destination

landed_cost
number <numeric>
price
number <numeric>

Brands retail price IN USD

wholesale_price
number <numeric>

Brands wholesale price IN USD

image
string <text>

External image url for the product, has to be in an http or https protocol.

hs_code
string <public.short_text>

Harmonized System Classification Number

length_mm
integer <integer>

Length of the packaging IN millimeters

height_mm
integer <integer>

Height of the packaging IN millimeters

width_mm
integer <integer>

Width of the packaging IN millimeters

weight_grams
integer <integer>

Weight of the product IN grams

is_active
boolean <boolean>

Is this product currently in use?

country_of_origin
string <public.short_text>
upc
string <text>

UPC Code

option_name_1
string <public.short_text>

Name of Option 1 Attribute

option_value_1
string <public.short_text>

Value of Option 1 Attribute

option_name_2
string <public.short_text>

Name of Option 2 Attribute

option_value_2
string <public.short_text>

Value of Option 2 Attribute

option_name_3
string <public.short_text>

Name of Option 3 Attribute

option_value_3
string <public.short_text>

Value of Option 3 Attribute

option_name_4
string <public.short_text>

Name of Option 4 Attribute

option_value_4
string <public.short_text>

Value of Option 4 Attribute

option_name_5
string <public.short_text>

Name of Option 5 Attribute

option_value_5
string <public.short_text>

Value of Option 5 Attribute

option_name_6
string <public.short_text>

Name of Option 6 Attribute

option_value_6
string <public.short_text>

Value of Option 6 Attribute

tags
Array of strings

Used TO Group certain products together INTO collections

category_1
string <public.short_text>

The top-level category of the product used to structure products into a hierarchy

category_2
string <public.short_text>

A subcategory nested under category_1

category_3
string <public.short_text>

A subcategory nested under category_2

category_4
string <public.short_text>

A subcategory nested under category_3

category_5
string <public.short_text>

A subcategory nested under category_4

category_6
string <public.short_text>

A subcategory nested under category_5

Responses

Request samples

Content type
{
  • "jwt": "string",
  • "name": "string",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "sku": "string",
  • "cost": 0,
  • "landed_cost": 0,
  • "price": 0,
  • "wholesale_price": 0,
  • "image": "string",
  • "hs_code": "string",
  • "length_mm": 0,
  • "height_mm": 0,
  • "width_mm": 0,
  • "weight_grams": 0,
  • "is_active": true,
  • "country_of_origin": "string",
  • "upc": "string",
  • "option_name_1": "string",
  • "option_value_1": "string",
  • "option_name_2": "string",
  • "option_value_2": "string",
  • "option_name_3": "string",
  • "option_value_3": "string",
  • "option_name_4": "string",
  • "option_value_4": "string",
  • "option_name_5": "string",
  • "option_value_5": "string",
  • "option_name_6": "string",
  • "option_value_6": "string",
  • "tags": [
    ],
  • "category_1": "string",
  • "category_2": "string",
  • "category_3": "string",
  • "category_4": "string",
  • "category_5": "string",
  • "category_6": "string"
}

webhook_actions

/webhook_actions

query Parameters
id
string <text>
description
string <text>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/webhook_actions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

webhook_actions

id
required
string <text>

Note: This is a Primary Key.

description
string <text>
Default: "NULL"

Responses

Request samples

Content type
{
  • "id": "string",
  • "description": "NULL"
}

/webhook_actions

query Parameters
id
string <text>
description
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/webhook_actions

query Parameters
id
string <text>
description
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

webhook_actions

id
required
string <text>

Note: This is a Primary Key.

description
string <text>
Default: "NULL"

Responses

Request samples

Content type
{
  • "id": "string",
  • "description": "NULL"
}

shipment_receipts_with_items

/shipment_receipts_with_items

query Parameters
id
string <uuid>
business_id
string <uuid>
shipment_id
string <uuid>
received_time
string <date-time>
completed_time
string <date-time>
additional_fields
string <jsonb>
external_ids
string <jsonb>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

shipment_receipt_inventory_items

/shipment_receipt_inventory_items

query Parameters
id
string <uuid>
business_id
string <uuid>
shipment_receipt_id
string <uuid>
inventory_item_id
string <uuid>
sku
string <text>
quantity
string <integer>
title
string <text>
comment
string <text>
receipt_time
string <date-time>
additional_fields
string <jsonb>
external_ids
string <jsonb>
available
string <boolean>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

currencies

A list of ISO 4217 currencies that can be used in the system with the corresponding magnifier

query Parameters
code
string <text>

The currency code, e.g. USD, BIF, JPY.

magnifier
string <integer>

The magnifier for the currency, e.g. 100 for USD, 1000 for BIF, 1 for JPY.

symbol
string <text>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

A list of ISO 4217 currencies that can be used in the system with the corresponding magnifier

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

currencies

code
required
string <text>

The currency code, e.g. USD, BIF, JPY.

Note: This is a Primary Key.

magnifier
required
integer <integer>

The magnifier for the currency, e.g. 100 for USD, 1000 for BIF, 1 for JPY.

symbol
required
string <text>

Responses

Request samples

Content type
{
  • "code": "string",
  • "magnifier": 0,
  • "symbol": "string"
}

A list of ISO 4217 currencies that can be used in the system with the corresponding magnifier

query Parameters
code
string <text>

The currency code, e.g. USD, BIF, JPY.

magnifier
string <integer>

The magnifier for the currency, e.g. 100 for USD, 1000 for BIF, 1 for JPY.

symbol
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A list of ISO 4217 currencies that can be used in the system with the corresponding magnifier

query Parameters
code
string <text>

The currency code, e.g. USD, BIF, JPY.

magnifier
string <integer>

The magnifier for the currency, e.g. 100 for USD, 1000 for BIF, 1 for JPY.

symbol
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

currencies

code
required
string <text>

The currency code, e.g. USD, BIF, JPY.

Note: This is a Primary Key.

magnifier
required
integer <integer>

The magnifier for the currency, e.g. 100 for USD, 1000 for BIF, 1 for JPY.

symbol
required
string <text>

Responses

Request samples

Content type
{
  • "code": "string",
  • "magnifier": 0,
  • "symbol": "string"
}

shipment_packages

Shipment packages are the physical packages that are shipped.

query Parameters
id
string <uuid>
business_id
string <uuid>
shipment_id
string <uuid>
additional_fields
string <jsonb>
external_ids
string <jsonb>
carton_id
string <text>

The carton id is a unique identifier for the carton unique by business, e.g. 123456789

ssc
string <text>
dimension
string <public.item_dimension>
pallet_number
string <integer>
license_plate
string <text>
currency_code
string <text>
pack_size
string <integer>
inner_packs
string <integer>
fulfillment_cost
string <integer>
shipping_cost
string <integer>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Shipment packages are the physical packages that are shipped.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

shipment_packages

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

shipment_id
required
string <uuid>
additional_fields
any <jsonb>
external_ids
any <jsonb>
carton_id
string <text>

The carton id is a unique identifier for the carton unique by business, e.g. 123456789

ssc
string <text>
dimension
string <public.item_dimension>
pallet_number
integer <integer>
license_plate
string <text>
currency_code
string <text>

Note: This is a Foreign Key to currencies.code.

pack_size
integer <integer>
inner_packs
integer <integer>
fulfillment_cost
integer <integer>
shipping_cost
integer <integer>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
  • "additional_fields": null,
  • "external_ids": null,
  • "carton_id": "string",
  • "ssc": "string",
  • "dimension": "string",
  • "pallet_number": 0,
  • "license_plate": "string",
  • "currency_code": "string",
  • "pack_size": 0,
  • "inner_packs": 0,
  • "fulfillment_cost": 0,
  • "shipping_cost": 0
}

Shipment packages are the physical packages that are shipped.

query Parameters
id
string <uuid>
business_id
string <uuid>
shipment_id
string <uuid>
additional_fields
string <jsonb>
external_ids
string <jsonb>
carton_id
string <text>

The carton id is a unique identifier for the carton unique by business, e.g. 123456789

ssc
string <text>
dimension
string <public.item_dimension>
pallet_number
string <integer>
license_plate
string <text>
currency_code
string <text>
pack_size
string <integer>
inner_packs
string <integer>
fulfillment_cost
string <integer>
shipping_cost
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Shipment packages are the physical packages that are shipped.

query Parameters
id
string <uuid>
business_id
string <uuid>
shipment_id
string <uuid>
additional_fields
string <jsonb>
external_ids
string <jsonb>
carton_id
string <text>

The carton id is a unique identifier for the carton unique by business, e.g. 123456789

ssc
string <text>
dimension
string <public.item_dimension>
pallet_number
string <integer>
license_plate
string <text>
currency_code
string <text>
pack_size
string <integer>
inner_packs
string <integer>
fulfillment_cost
string <integer>
shipping_cost
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

shipment_packages

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

shipment_id
required
string <uuid>
additional_fields
any <jsonb>
external_ids
any <jsonb>
carton_id
string <text>

The carton id is a unique identifier for the carton unique by business, e.g. 123456789

ssc
string <text>
dimension
string <public.item_dimension>
pallet_number
integer <integer>
license_plate
string <text>
currency_code
string <text>

Note: This is a Foreign Key to currencies.code.

pack_size
integer <integer>
inner_packs
integer <integer>
fulfillment_cost
integer <integer>
shipping_cost
integer <integer>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
  • "additional_fields": null,
  • "external_ids": null,
  • "carton_id": "string",
  • "ssc": "string",
  • "dimension": "string",
  • "pallet_number": 0,
  • "license_plate": "string",
  • "currency_code": "string",
  • "pack_size": 0,
  • "inner_packs": 0,
  • "fulfillment_cost": 0,
  • "shipping_cost": 0
}

shipment_inventory_items

/shipment_inventory_items

query Parameters
id
string <uuid>
shipment_id
string <uuid>
shipment_package_id
string <uuid>
inventory_item_id
string <uuid>
sku
string <text>
title
string <text>
additional_fields
string <jsonb>
external_ids
string <jsonb>
line_number
string <smallint>
quantity
string <integer>
name
string <text>
upc
string <text>
lot_number
string <text>
hs_code
string <text>
hts_code
string <text>
country_of_origin
string <text>
serial_number
string <text>
currency_code
string <text>
unit_price
string <numeric>
discounted_price
string <numeric>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

shipments

Shipments are the physical movement of goods from one location to another.

Theses values tend to come from external systems and are a bit more raw than the other tables. Because of that the values are not overly strict and are more of a best effort to store the data. When the shipment is linked to an order or it's packages are linked to a fulfillment then inventory_adjustments are created as fulfillments tend to be more strict.

query Parameters
id
string <uuid>
business_id
string <uuid>
billing_address_id
string <uuid>
shipment_number
string <text>

The shipment number is a unique identifier for the shipment unique by business, e.g. 123456789

bill_of_lading
string <text>

Similar to a tracking number this is created by the party shipping the goods, e.g. 614141123456791

order_number
string <text>

The order number is a unique identifier for the order by business, should match the order number in the order but no guarantee

external_ids
string <jsonb>

External ids are a way to store ids from other systems

additional_fields
string <jsonb>

Additional fields are a way to store additional information about the shipment

carrier
string <text>

Carrier used to transport this shipment, e.g. Fedex

service
string <text>

The carrier service used to transport this shipment. e.g. Ground

scac
string <text>

Standard carrier alpha code is a standardized code used to represent the carrier and service, e.g. FEDG

tracking_number
string <text>

A unique number assigned to the shipment that can be used to track its progress, e.g. 395222844180

tracking_urls
string <public.url[]>
ship_by_time
string <date-time>

The date the shipment should be shipped by.

deliver_by_time
string <date-time>

The date the shipment should be delivered by.

cancel_by_time
string <date-time>

The date the shipment should be cancelled by.

shipped_time
string <date-time>

The date the shipment was shipped.

received_time
string <date-time>

The date the shipment was received.

estimated_arrival_time
string <date-time>

The estimated date the shipment will arrive.

cancelled_time
string <date-time>

The date the shipment was cancelled.

status
string <public.shipment_status>
location_to_id
string <uuid>
location_from_id
string <uuid>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Shipments are the physical movement of goods from one location to another.

Theses values tend to come from external systems and are a bit more raw than the other tables. Because of that the values are not overly strict and are more of a best effort to store the data. When the shipment is linked to an order or it's packages are linked to a fulfillment then inventory_adjustments are created as fulfillments tend to be more strict.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

shipments

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

billing_address_id
string <uuid>
shipment_number
required
string <text>

The shipment number is a unique identifier for the shipment unique by business, e.g. 123456789

bill_of_lading
string <text>

Similar to a tracking number this is created by the party shipping the goods, e.g. 614141123456791

order_number
string <text>

The order number is a unique identifier for the order by business, should match the order number in the order but no guarantee

external_ids
any <jsonb>

External ids are a way to store ids from other systems

additional_fields
any <jsonb>

Additional fields are a way to store additional information about the shipment

carrier
string <text>

Carrier used to transport this shipment, e.g. Fedex

service
string <text>

The carrier service used to transport this shipment. e.g. Ground

scac
string <text>

Standard carrier alpha code is a standardized code used to represent the carrier and service, e.g. FEDG

tracking_number
string <text>

A unique number assigned to the shipment that can be used to track its progress, e.g. 395222844180

tracking_urls
Array of strings
ship_by_time
string <date-time>

The date the shipment should be shipped by.

deliver_by_time
string <date-time>

The date the shipment should be delivered by.

cancel_by_time
string <date-time>

The date the shipment should be cancelled by.

shipped_time
string <date-time>

The date the shipment was shipped.

received_time
string <date-time>

The date the shipment was received.

estimated_arrival_time
string <date-time>

The estimated date the shipment will arrive.

cancelled_time
string <date-time>

The date the shipment was cancelled.

status
string <public.shipment_status>
Default: "unshipped"
Enum: "unshipped" "shipped" "cancelled" "closed"
location_to_id
string <uuid>
location_from_id
string <uuid>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "shipment_number": "string",
  • "bill_of_lading": "string",
  • "order_number": "string",
  • "external_ids": null,
  • "additional_fields": null,
  • "carrier": "string",
  • "service": "string",
  • "scac": "string",
  • "tracking_number": "string",
  • "tracking_urls": [
    ],
  • "ship_by_time": "2019-08-24T14:15:22Z",
  • "deliver_by_time": "2019-08-24T14:15:22Z",
  • "cancel_by_time": "2019-08-24T14:15:22Z",
  • "shipped_time": "2019-08-24T14:15:22Z",
  • "received_time": "2019-08-24T14:15:22Z",
  • "estimated_arrival_time": "2019-08-24T14:15:22Z",
  • "cancelled_time": "2019-08-24T14:15:22Z",
  • "status": "unshipped",
  • "location_to_id": "c52173fd-0753-46a8-97bf-e04722e81760",
  • "location_from_id": "b514c6fd-d07b-4930-a724-047b7cea3155"
}

Shipments are the physical movement of goods from one location to another.

Theses values tend to come from external systems and are a bit more raw than the other tables. Because of that the values are not overly strict and are more of a best effort to store the data. When the shipment is linked to an order or it's packages are linked to a fulfillment then inventory_adjustments are created as fulfillments tend to be more strict.

query Parameters
id
string <uuid>
business_id
string <uuid>
billing_address_id
string <uuid>
shipment_number
string <text>

The shipment number is a unique identifier for the shipment unique by business, e.g. 123456789

bill_of_lading
string <text>

Similar to a tracking number this is created by the party shipping the goods, e.g. 614141123456791

order_number
string <text>

The order number is a unique identifier for the order by business, should match the order number in the order but no guarantee

external_ids
string <jsonb>

External ids are a way to store ids from other systems

additional_fields
string <jsonb>

Additional fields are a way to store additional information about the shipment

carrier
string <text>

Carrier used to transport this shipment, e.g. Fedex

service
string <text>

The carrier service used to transport this shipment. e.g. Ground

scac
string <text>

Standard carrier alpha code is a standardized code used to represent the carrier and service, e.g. FEDG

tracking_number
string <text>

A unique number assigned to the shipment that can be used to track its progress, e.g. 395222844180

tracking_urls
string <public.url[]>
ship_by_time
string <date-time>

The date the shipment should be shipped by.

deliver_by_time
string <date-time>

The date the shipment should be delivered by.

cancel_by_time
string <date-time>

The date the shipment should be cancelled by.

shipped_time
string <date-time>

The date the shipment was shipped.

received_time
string <date-time>

The date the shipment was received.

estimated_arrival_time
string <date-time>

The estimated date the shipment will arrive.

cancelled_time
string <date-time>

The date the shipment was cancelled.

status
string <public.shipment_status>
location_to_id
string <uuid>
location_from_id
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Shipments are the physical movement of goods from one location to another.

Theses values tend to come from external systems and are a bit more raw than the other tables. Because of that the values are not overly strict and are more of a best effort to store the data. When the shipment is linked to an order or it's packages are linked to a fulfillment then inventory_adjustments are created as fulfillments tend to be more strict.

query Parameters
id
string <uuid>
business_id
string <uuid>
billing_address_id
string <uuid>
shipment_number
string <text>

The shipment number is a unique identifier for the shipment unique by business, e.g. 123456789

bill_of_lading
string <text>

Similar to a tracking number this is created by the party shipping the goods, e.g. 614141123456791

order_number
string <text>

The order number is a unique identifier for the order by business, should match the order number in the order but no guarantee

external_ids
string <jsonb>

External ids are a way to store ids from other systems

additional_fields
string <jsonb>

Additional fields are a way to store additional information about the shipment

carrier
string <text>

Carrier used to transport this shipment, e.g. Fedex

service
string <text>

The carrier service used to transport this shipment. e.g. Ground

scac
string <text>

Standard carrier alpha code is a standardized code used to represent the carrier and service, e.g. FEDG

tracking_number
string <text>

A unique number assigned to the shipment that can be used to track its progress, e.g. 395222844180

tracking_urls
string <public.url[]>
ship_by_time
string <date-time>

The date the shipment should be shipped by.

deliver_by_time
string <date-time>

The date the shipment should be delivered by.

cancel_by_time
string <date-time>

The date the shipment should be cancelled by.

shipped_time
string <date-time>

The date the shipment was shipped.

received_time
string <date-time>

The date the shipment was received.

estimated_arrival_time
string <date-time>

The estimated date the shipment will arrive.

cancelled_time
string <date-time>

The date the shipment was cancelled.

status
string <public.shipment_status>
location_to_id
string <uuid>
location_from_id
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

shipments

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

billing_address_id
string <uuid>
shipment_number
required
string <text>

The shipment number is a unique identifier for the shipment unique by business, e.g. 123456789

bill_of_lading
string <text>

Similar to a tracking number this is created by the party shipping the goods, e.g. 614141123456791

order_number
string <text>

The order number is a unique identifier for the order by business, should match the order number in the order but no guarantee

external_ids
any <jsonb>

External ids are a way to store ids from other systems

additional_fields
any <jsonb>

Additional fields are a way to store additional information about the shipment

carrier
string <text>

Carrier used to transport this shipment, e.g. Fedex

service
string <text>

The carrier service used to transport this shipment. e.g. Ground

scac
string <text>

Standard carrier alpha code is a standardized code used to represent the carrier and service, e.g. FEDG

tracking_number
string <text>

A unique number assigned to the shipment that can be used to track its progress, e.g. 395222844180

tracking_urls
Array of strings
ship_by_time
string <date-time>

The date the shipment should be shipped by.

deliver_by_time
string <date-time>

The date the shipment should be delivered by.

cancel_by_time
string <date-time>

The date the shipment should be cancelled by.

shipped_time
string <date-time>

The date the shipment was shipped.

received_time
string <date-time>

The date the shipment was received.

estimated_arrival_time
string <date-time>

The estimated date the shipment will arrive.

cancelled_time
string <date-time>

The date the shipment was cancelled.

status
string <public.shipment_status>
Default: "unshipped"
Enum: "unshipped" "shipped" "cancelled" "closed"
location_to_id
string <uuid>
location_from_id
string <uuid>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "shipment_number": "string",
  • "bill_of_lading": "string",
  • "order_number": "string",
  • "external_ids": null,
  • "additional_fields": null,
  • "carrier": "string",
  • "service": "string",
  • "scac": "string",
  • "tracking_number": "string",
  • "tracking_urls": [
    ],
  • "ship_by_time": "2019-08-24T14:15:22Z",
  • "deliver_by_time": "2019-08-24T14:15:22Z",
  • "cancel_by_time": "2019-08-24T14:15:22Z",
  • "shipped_time": "2019-08-24T14:15:22Z",
  • "received_time": "2019-08-24T14:15:22Z",
  • "estimated_arrival_time": "2019-08-24T14:15:22Z",
  • "cancelled_time": "2019-08-24T14:15:22Z",
  • "status": "unshipped",
  • "location_to_id": "c52173fd-0753-46a8-97bf-e04722e81760",
  • "location_from_id": "b514c6fd-d07b-4930-a724-047b7cea3155"
}

inventory_item_quantity_adjustments_current

A current roll up of your inventory item adjustments.

query Parameters
id
string <uuid>
inventory_item_id
string <uuid>
location_id
string <uuid>
business_id
string <uuid>
status
string <public.inventory_item_status>

The status of the inventory item at the location.

quantity
string <integer>

The quantity of the inventory item at the location, previously known as current_quantity.

creation_time
string <date-time>

The time the inventory item quantity was created, defaults to now.

update_time
string <date-time>
legacy_adjustment
string <boolean>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

A current roll up of your inventory item adjustments.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

inventory_item_quantity_adjustments_current

id
string <uuid>

Note: This is a Primary Key.

inventory_item_id
string <uuid>
location_id
string <uuid>
business_id
string <uuid>

Note: This is a Foreign Key to businesses.id.

status
string <public.inventory_item_status>
Enum: "available_to_sell" "committed" "on_hand" "on_hold" "on_order" "reserve" "incoming" "unavailable"

The status of the inventory item at the location.

quantity
integer <integer>

The quantity of the inventory item at the location, previously known as current_quantity.

creation_time
string <date-time>

The time the inventory item quantity was created, defaults to now.

update_time
string <date-time>
legacy_adjustment
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "status": "available_to_sell",
  • "quantity": 0,
  • "creation_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "legacy_adjustment": true
}

A current roll up of your inventory item adjustments.

query Parameters
id
string <uuid>
inventory_item_id
string <uuid>
location_id
string <uuid>
business_id
string <uuid>
status
string <public.inventory_item_status>

The status of the inventory item at the location.

quantity
string <integer>

The quantity of the inventory item at the location, previously known as current_quantity.

creation_time
string <date-time>

The time the inventory item quantity was created, defaults to now.

update_time
string <date-time>
legacy_adjustment
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A current roll up of your inventory item adjustments.

query Parameters
id
string <uuid>
inventory_item_id
string <uuid>
location_id
string <uuid>
business_id
string <uuid>
status
string <public.inventory_item_status>

The status of the inventory item at the location.

quantity
string <integer>

The quantity of the inventory item at the location, previously known as current_quantity.

creation_time
string <date-time>

The time the inventory item quantity was created, defaults to now.

update_time
string <date-time>
legacy_adjustment
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

inventory_item_quantity_adjustments_current

id
string <uuid>

Note: This is a Primary Key.

inventory_item_id
string <uuid>
location_id
string <uuid>
business_id
string <uuid>

Note: This is a Foreign Key to businesses.id.

status
string <public.inventory_item_status>
Enum: "available_to_sell" "committed" "on_hand" "on_hold" "on_order" "reserve" "incoming" "unavailable"

The status of the inventory item at the location.

quantity
integer <integer>

The quantity of the inventory item at the location, previously known as current_quantity.

creation_time
string <date-time>

The time the inventory item quantity was created, defaults to now.

update_time
string <date-time>
legacy_adjustment
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "status": "available_to_sell",
  • "quantity": 0,
  • "creation_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "legacy_adjustment": true
}

product_categories

The categories that a product belongs to

query Parameters
product_id
string <uuid>

The product that the category belongs to

category_id
string <uuid>

The category

child_category_id
string <uuid>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

The categories that a product belongs to

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

product_categories

product_id
required
string <uuid>

The product that the category belongs to

Note: This is a Primary Key. This is a Foreign Key to products.id.

category_id
required
string <uuid>

The category

Note: This is a Primary Key. This is a Foreign Key to categories.id.

child_category_id
string <uuid>

Note: This is a Foreign Key to categories.id.

Responses

Request samples

Content type
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  • "child_category_id": "c65db922-eca9-41e9-94f8-256ae2667307"
}

The categories that a product belongs to

query Parameters
product_id
string <uuid>

The product that the category belongs to

category_id
string <uuid>

The category

child_category_id
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

The categories that a product belongs to

query Parameters
product_id
string <uuid>

The product that the category belongs to

category_id
string <uuid>

The category

child_category_id
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

product_categories

product_id
required
string <uuid>

The product that the category belongs to

Note: This is a Primary Key. This is a Foreign Key to products.id.

category_id
required
string <uuid>

The category

Note: This is a Primary Key. This is a Foreign Key to categories.id.

child_category_id
string <uuid>

Note: This is a Foreign Key to categories.id.

Responses

Request samples

Content type
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  • "child_category_id": "c65db922-eca9-41e9-94f8-256ae2667307"
}

refund_adjustments

/refund_adjustments

query Parameters
id
string <uuid>
business_id
string <uuid>
adjustment_id
string <character varying>
amount
string <numeric>
reason
string <character varying>
tax_amount
string <numeric>
refund_id
string <uuid>
external_ids
string <jsonb>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/refund_adjustments

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

refund_adjustments

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

adjustment_id
required
string <character varying> <= 100 characters
amount
required
number <numeric>
reason
string <character varying> <= 255 characters
tax_amount
number <numeric>
refund_id
required
string <uuid>

Note: This is a Foreign Key to refunds.id.

external_ids
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "adjustment_id": "string",
  • "amount": 0,
  • "reason": "string",
  • "tax_amount": 0,
  • "refund_id": "63c72644-8ac7-4527-8b49-bb7e9f190cb0",
  • "external_ids": null
}

/refund_adjustments

query Parameters
id
string <uuid>
business_id
string <uuid>
adjustment_id
string <character varying>
amount
string <numeric>
reason
string <character varying>
tax_amount
string <numeric>
refund_id
string <uuid>
external_ids
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/refund_adjustments

query Parameters
id
string <uuid>
business_id
string <uuid>
adjustment_id
string <character varying>
amount
string <numeric>
reason
string <character varying>
tax_amount
string <numeric>
refund_id
string <uuid>
external_ids
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

refund_adjustments

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

adjustment_id
required
string <character varying> <= 100 characters
amount
required
number <numeric>
reason
string <character varying> <= 255 characters
tax_amount
number <numeric>
refund_id
required
string <uuid>

Note: This is a Foreign Key to refunds.id.

external_ids
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "adjustment_id": "string",
  • "amount": 0,
  • "reason": "string",
  • "tax_amount": 0,
  • "refund_id": "63c72644-8ac7-4527-8b49-bb7e9f190cb0",
  • "external_ids": null
}

refund_transactions

/refund_transactions

query Parameters
id
string <uuid>
business_id
string <uuid>
amount
string <numeric>
message
string <character varying>
transaction_id
string <character varying>
refund_id
string <uuid>
external_ids
string <jsonb>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/refund_transactions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

refund_transactions

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

amount
required
number <numeric>
message
string <character varying> <= 255 characters
transaction_id
required
string <character varying> <= 100 characters
refund_id
required
string <uuid>

Note: This is a Foreign Key to refunds.id.

external_ids
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "amount": 0,
  • "message": "string",
  • "transaction_id": "string",
  • "refund_id": "63c72644-8ac7-4527-8b49-bb7e9f190cb0",
  • "external_ids": null
}

/refund_transactions

query Parameters
id
string <uuid>
business_id
string <uuid>
amount
string <numeric>
message
string <character varying>
transaction_id
string <character varying>
refund_id
string <uuid>
external_ids
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/refund_transactions

query Parameters
id
string <uuid>
business_id
string <uuid>
amount
string <numeric>
message
string <character varying>
transaction_id
string <character varying>
refund_id
string <uuid>
external_ids
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

refund_transactions

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

business_id
required
string <uuid>

Note: This is a Foreign Key to businesses.id.

amount
required
number <numeric>
message
string <character varying> <= 255 characters
transaction_id
required
string <character varying> <= 100 characters
refund_id
required
string <uuid>

Note: This is a Foreign Key to refunds.id.

external_ids
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "amount": 0,
  • "message": "string",
  • "transaction_id": "string",
  • "refund_id": "63c72644-8ac7-4527-8b49-bb7e9f190cb0",
  • "external_ids": null
}

businesses

/businesses

query Parameters
id
string <uuid>
name
string <text>
alphabetic_currency_code
string <text>
timezone_id
string <text>
inventory_item_key
string <text>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/businesses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

businesses

id
required
string <uuid>
Default: "extensions.uuid_generate_v4()"

Note: This is a Primary Key.

name
required
string <text>
alphabetic_currency_code
string <text>

Note: This is a Foreign Key to currencies.code.

timezone_id
string <text>
inventory_item_key
string <text>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "name": "string",
  • "alphabetic_currency_code": "string",
  • "timezone_id": "string",
  • "inventory_item_key": "string"
}