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.
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

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:
application/json

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.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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.
creation_time	string <date-time>
update_time	string <date-time>

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.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"name": "string",
"value": "string",
"ordinal": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

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:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"name": "string",
"value": "string",
"ordinal": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"name": "string",
"value": "string",
"ordinal": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

webhook_configurations

/webhook_configurations

query Parameters

id	string <uuid>
business_id	string <uuid>
hook_producer_url	string <text>
hook_consumer_url	string <text>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"hook_producer_url": "string",
"hook_consumer_url": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/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:
application/json

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>
hook_consumer_url required	string <text>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"hook_producer_url": "string",
"hook_consumer_url": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/webhook_configurations

query Parameters

id	string <uuid>
business_id	string <uuid>
hook_producer_url	string <text>
hook_consumer_url	string <text>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
hook_consumer_url required	string <text>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"hook_producer_url": "string",
"hook_consumer_url": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

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:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

product_data

/product_data

query Parameters

jwt	string <text>
name	string <public.short_text>
business_id	string <uuid>
sku	string <public.short_text>
cost	string <numeric>
landed_cost	string <numeric>
price	string <numeric>
wholesale_price	string <numeric>
image	string <text>
hs_code	string <public.short_text>
length_mm	string <integer>
height_mm	string <integer>
width_mm	string <integer>
weight_grams	string <integer>
is_active	string <boolean>
country_of_origin	string <public.short_text>
upc	string <text>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>
tags	string <text[]>
category_1	string <public.short_text>
category_2	string <public.short_text>
category_3	string <public.short_text>
category_4	string <public.short_text>
category_5	string <public.short_text>
category_6	string <public.short_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

200

Content type

application/json

[{"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": ["string"
],
"category_1": "string",
"category_2": "string",
"category_3": "string",
"category_4": "string",
"category_5": "string",
"category_6": "string"
}
]

/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:
application/json

product_data

jwt	string <text>
name	string <public.short_text>
business_id	string <uuid>
sku	string <public.short_text>
cost	number <numeric>
landed_cost	number <numeric>
price	number <numeric>
wholesale_price	number <numeric>
image	string <text>
hs_code	string <public.short_text>
length_mm	integer <integer>
height_mm	integer <integer>
width_mm	integer <integer>
weight_grams	integer <integer>
is_active	boolean <boolean>
country_of_origin	string <public.short_text>
upc	string <text>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>
tags	Array of strings
category_1	string <public.short_text>
category_2	string <public.short_text>
category_3	string <public.short_text>
category_4	string <public.short_text>
category_5	string <public.short_text>
category_6	string <public.short_text>

Responses

Request samples

Payload

Content type

application/json

{"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": ["string"
],
"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>
business_id	string <uuid>
sku	string <public.short_text>
cost	string <numeric>
landed_cost	string <numeric>
price	string <numeric>
wholesale_price	string <numeric>
image	string <text>
hs_code	string <public.short_text>
length_mm	string <integer>
height_mm	string <integer>
width_mm	string <integer>
weight_grams	string <integer>
is_active	string <boolean>
country_of_origin	string <public.short_text>
upc	string <text>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>
tags	string <text[]>
category_1	string <public.short_text>
category_2	string <public.short_text>
category_3	string <public.short_text>
category_4	string <public.short_text>
category_5	string <public.short_text>
category_6	string <public.short_text>

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>
business_id	string <uuid>
sku	string <public.short_text>
cost	string <numeric>
landed_cost	string <numeric>
price	string <numeric>
wholesale_price	string <numeric>
image	string <text>
hs_code	string <public.short_text>
length_mm	string <integer>
height_mm	string <integer>
width_mm	string <integer>
weight_grams	string <integer>
is_active	string <boolean>
country_of_origin	string <public.short_text>
upc	string <text>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>
tags	string <text[]>
category_1	string <public.short_text>
category_2	string <public.short_text>
category_3	string <public.short_text>
category_4	string <public.short_text>
category_5	string <public.short_text>
category_6	string <public.short_text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

product_data

jwt	string <text>
name	string <public.short_text>
business_id	string <uuid>
sku	string <public.short_text>
cost	number <numeric>
landed_cost	number <numeric>
price	number <numeric>
wholesale_price	number <numeric>
image	string <text>
hs_code	string <public.short_text>
length_mm	integer <integer>
height_mm	integer <integer>
width_mm	integer <integer>
weight_grams	integer <integer>
is_active	boolean <boolean>
country_of_origin	string <public.short_text>
upc	string <text>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>
tags	Array of strings
category_1	string <public.short_text>
category_2	string <public.short_text>
category_3	string <public.short_text>
category_4	string <public.short_text>
category_5	string <public.short_text>
category_6	string <public.short_text>

Responses

Request samples

Payload

Content type

application/json

{"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": ["string"
],
"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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "string",
"description": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/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:
application/json

webhook_actions

id required	string <text> Note: This is a Primary Key.
description	string <text>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"description": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/webhook_actions

query Parameters

id	string <text>
description	string <text>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/webhook_actions

query Parameters

id	string <text>
description	string <text>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

webhook_actions

id required	string <text> Note: This is a Primary Key.
description	string <text>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"description": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"received_time": "2019-08-24T14:15:22Z",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"quantity": 0,
"title": "string",
"comment": "string",
"receipt_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"available": true
}
]
}
]

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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"quantity": 0,
"title": "string",
"comment": "string",
"receipt_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"available": true
}
]

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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"code": "string",
"magnifier": 0,
"symbol": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

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:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"magnifier": 0,
"symbol": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"magnifier": 0,
"symbol": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

countries

ISO 3166-1 alpha-2 country codes and names

query Parameters

code	string <text>
name	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

200

Content type

application/json

[{"code": "string",
"name": "string"
}
]

ISO 3166-1 alpha-2 country codes and names

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:
application/json

countries

code required	string <text> Note: This is a Primary Key.
name required	string <text>

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string"
}

ISO 3166-1 alpha-2 country codes and names

query Parameters

code	string <text>
name	string <text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

ISO 3166-1 alpha-2 country codes and names

query Parameters

code	string <text>
name	string <text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

countries

code required	string <text> Note: This is a Primary Key.
name required	string <text>

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

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:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

orders_full

/orders_full

query Parameters

id	string <uuid>
business_id	string <uuid>
channel_id	string <uuid>
customer_id	string <uuid>
external_ids	string <jsonb>
channel_order_id	string <text>
additional_fields	string <jsonb>
status	string <public.order_status>
order_type	string <public.order_type>
purchase_order_number	string <text>
currency_code	string <text>
subtotal_price	string <integer>
total_price	string <integer>
total_shipping_price	string <integer>
total_tax	string <integer>
total_shipping_tax	string <integer>
total_grams	string <numeric>
purchased_time	string <date-time>
canceled_time	string <date-time>
ships_by_time	string <date-time>
canceled_reason	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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"address_to": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"address_from": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"external_ids": null,
"channel_order_id": "string",
"additional_fields": null,
"status": "open",
"order_type": "sales_order",
"purchase_order_number": "string",
"currency_code": "string",
"subtotal_price": 0,
"total_price": 0,
"total_shipping_price": 0,
"total_tax": 0,
"total_shipping_tax": 0,
"total_grams": 0,
"purchased_time": "2019-08-24T14:15:22Z",
"canceled_time": "2019-08-24T14:15:22Z",
"ships_by_time": "2019-08-24T14:15:22Z",
"canceled_reason": "string"
}
]

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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
]

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>
creation_time	string <date-time>
update_time	string <date-time>
internal_note	string <text>
external_note	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

200

Content type

application/json

[{"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": ["string"
],
"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",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z",
"internal_note": "string",
"external_note": "string"
}
]

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:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>
internal_note	string <text>
external_note	string <text>

Responses

Request samples

Payload

Content type

application/json

{"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": ["string"
],
"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",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z",
"internal_note": "string",
"external_note": "string"
}

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>
creation_time	string <date-time>
update_time	string <date-time>
internal_note	string <text>
external_note	string <text>

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>
creation_time	string <date-time>
update_time	string <date-time>
internal_note	string <text>
external_note	string <text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>
internal_note	string <text>
external_note	string <text>

Responses

Request samples

Payload

Content type

application/json

{"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": ["string"
],
"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",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z",
"internal_note": "string",
"external_note": "string"
}

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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"child_category_id": "c65db922-eca9-41e9-94f8-256ae2667307",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

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:
application/json

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`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"child_category_id": "c65db922-eca9-41e9-94f8-256ae2667307",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"child_category_id": "c65db922-eca9-41e9-94f8-256ae2667307",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/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:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/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>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

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>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/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:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/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>
creation_time	string <date-time>
update_time	string <date-time>

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>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

businesses

/businesses

query Parameters

id	string <uuid>
name	string <text>
alphabetic_currency_code	string <text>
timezone_id	string <text>
inventory_item_key	string <text>
legacy_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"name": "string",
"alphabetic_currency_code": "string",
"timezone_id": "string",
"inventory_item_key": "string",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/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:
application/json

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>
legacy_id	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"name": "string",
"alphabetic_currency_code": "string",
"timezone_id": "string",
"inventory_item_key": "string",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/businesses

query Parameters

id	string <uuid>
name	string <text>
alphabetic_currency_code	string <text>
timezone_id	string <text>
inventory_item_key	string <text>
legacy_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/businesses

query Parameters

id	string <uuid>
name	string <text>
alphabetic_currency_code	string <text>
timezone_id	string <text>
inventory_item_key	string <text>
legacy_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

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>
legacy_id	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"name": "string",
"alphabetic_currency_code": "string",
"timezone_id": "string",
"inventory_item_key": "string",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

shipments_full

/shipments_full

query Parameters

id	string <uuid>
business_id	string <uuid>
shipment_number	string <text>
status	string <public.shipment_status>
bill_of_lading	string <text>
order_number	string <text>
external_ids	string <jsonb>
additional_fields	string <jsonb>
carrier	string <text>
service	string <text>
scac	string <text>
tracking_number	string <text>
tracking_urls	string <public.url[]>
ship_by_time	string <date-time>
deliver_by_time	string <date-time>
cancel_by_time	string <date-time>
shipped_time	string <date-time>
received_time	string <date-time>
estimated_arrival_time	string <date-time>
cancelled_time	string <date-time>
internal_note	string <text>
external_note	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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_number": "string",
"status": "unshipped",
"bill_of_lading": "string",
"order_number": "string",
"external_ids": null,
"additional_fields": null,
"carrier": "string",
"service": "string",
"scac": "string",
"tracking_number": "string",
"tracking_urls": ["string"
],
"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",
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"from_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"to_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"packages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
]
}
],
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
],
"internal_note": "string",
"external_note": "string"
}
]

products

Highest level information about a product.

query Parameters

id	string <uuid> A generated product ID
name	string <public.short_text> The name of the product
business_id	string <uuid> The business that owns the product
is_active	string <boolean> Determines whether or not the product is active
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"name": "string",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"is_active": true,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

Highest level information about a product.

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:
application/json

products

id required	string <uuid> Default: "extensions.uuid_generate_v4()" A generated product ID Note: This is a Primary Key.
name required	string <public.short_text> The name of the product
business_id required	string <uuid> The business that owns the product
is_active required	boolean <boolean> Default: true Determines whether or not the product is active
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"name": "string",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"is_active": true,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

Highest level information about a product.

query Parameters

id	string <uuid> A generated product ID
name	string <public.short_text> The name of the product
business_id	string <uuid> The business that owns the product
is_active	string <boolean> Determines whether or not the product is active
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Highest level information about a product.

query Parameters

id	string <uuid> A generated product ID
name	string <public.short_text> The name of the product
business_id	string <uuid> The business that owns the product
is_active	string <boolean> Determines whether or not the product is active
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

products

id required	string <uuid> Default: "extensions.uuid_generate_v4()" A generated product ID Note: This is a Primary Key.
name required	string <public.short_text> The name of the product
business_id required	string <uuid> The business that owns the product
is_active required	boolean <boolean> Default: true Determines whether or not the product is active
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"name": "string",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"is_active": true,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

shipment_receipt_items

Record of items received in a shipment

query Parameters

id	string <uuid> Unique identifier for the shipment receipt item
business_id	string <uuid> The business that this receipt item is for
shipment_receipt_id	string <uuid> The shipment receipt that this item is for
inventory_item_id	string <uuid> The inventory item that this receipt item is for
quantity	string <integer> The quantity of the inventory item that was received
comment	string <text> A comment about the receipt item
receipt_time	string <date-time> The time the receipt item was recorded
additional_fields	string <jsonb> Additional fields to store miscellaneous data
external_ids	string <jsonb>
available	string <boolean> Was the item was received in good condition? defaults to true
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"quantity": 0,
"comment": "string",
"receipt_time": "now()",
"additional_fields": null,
"external_ids": null,
"available": true,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

Record of items received in a shipment

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:
application/json

shipment_receipt_items

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Unique identifier for the shipment receipt item Note: This is a Primary Key.
business_id required	string <uuid> The business that this receipt item is for Note: This is a Foreign Key to `businesses.id`.
shipment_receipt_id required	string <uuid> The shipment receipt that this item is for
inventory_item_id required	string <uuid> The inventory item that this receipt item is for
quantity required	integer <integer> The quantity of the inventory item that was received
comment	string <text> A comment about the receipt item
receipt_time required	string <date-time> Default: "now()" The time the receipt item was recorded
additional_fields	any <jsonb> Additional fields to store miscellaneous data
external_ids	any <jsonb>
available required	boolean <boolean> Default: true Was the item was received in good condition? defaults to true
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"quantity": 0,
"comment": "string",
"receipt_time": "now()",
"additional_fields": null,
"external_ids": null,
"available": true,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

Record of items received in a shipment

query Parameters

id	string <uuid> Unique identifier for the shipment receipt item
business_id	string <uuid> The business that this receipt item is for
shipment_receipt_id	string <uuid> The shipment receipt that this item is for
inventory_item_id	string <uuid> The inventory item that this receipt item is for
quantity	string <integer> The quantity of the inventory item that was received
comment	string <text> A comment about the receipt item
receipt_time	string <date-time> The time the receipt item was recorded
additional_fields	string <jsonb> Additional fields to store miscellaneous data
external_ids	string <jsonb>
available	string <boolean> Was the item was received in good condition? defaults to true
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Record of items received in a shipment

query Parameters

id	string <uuid> Unique identifier for the shipment receipt item
business_id	string <uuid> The business that this receipt item is for
shipment_receipt_id	string <uuid> The shipment receipt that this item is for
inventory_item_id	string <uuid> The inventory item that this receipt item is for
quantity	string <integer> The quantity of the inventory item that was received
comment	string <text> A comment about the receipt item
receipt_time	string <date-time> The time the receipt item was recorded
additional_fields	string <jsonb> Additional fields to store miscellaneous data
external_ids	string <jsonb>
available	string <boolean> Was the item was received in good condition? defaults to true
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

shipment_receipt_items

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Unique identifier for the shipment receipt item Note: This is a Primary Key.
business_id required	string <uuid> The business that this receipt item is for Note: This is a Foreign Key to `businesses.id`.
shipment_receipt_id required	string <uuid> The shipment receipt that this item is for
inventory_item_id required	string <uuid> The inventory item that this receipt item is for
quantity required	integer <integer> The quantity of the inventory item that was received
comment	string <text> A comment about the receipt item
receipt_time required	string <date-time> Default: "now()" The time the receipt item was recorded
additional_fields	any <jsonb> Additional fields to store miscellaneous data
external_ids	any <jsonb>
available required	boolean <boolean> Default: true Was the item was received in good condition? defaults to true
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"quantity": 0,
"comment": "string",
"receipt_time": "now()",
"additional_fields": null,
"external_ids": null,
"available": true,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

inventory_item_current_quantities_live

This view will return the current inventory quantities for each inventory item and location.

Uses the live rollup table instead of the materialized view. ** Do not depend on this view as it will be dropped **

query Parameters

business_id	string <uuid>
inventory_item_id	string <uuid>
location_id	string <uuid>
available_to_sell	string <bigint>
committed	string <bigint>
on_hand	string <bigint>
on_hold	string <bigint>
on_order	string <bigint>
reserve	string <bigint>
incoming	string <bigint>
unavailable	string <bigint>
available_to_promise	string <bigint>
sku	string <text>
title	string <text>
location	string <text>
location_legacy_id	string <integer>
inventory_item_legacy_id	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

200

Content type

application/json

[{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
"available_to_sell": 0,
"committed": 0,
"on_hand": 0,
"on_hold": 0,
"on_order": 0,
"reserve": 0,
"incoming": 0,
"unavailable": 0,
"available_to_promise": 0,
"sku": "string",
"title": "string",
"location": "string",
"location_legacy_id": 0,
"inventory_item_legacy_id": 0
}
]

fulfillment_shipments_items

A join table between fulfillments and shipment_items.

A single fulfillment can have multiple shipment_items and a single shipment_item can only belong to a single fulfillment.

query Parameters

business_id	string <uuid>
fulfillment_id	string <uuid>
shipment_item_id	string <uuid>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"fulfillment_id": "097dfd3a-2243-488a-bb9e-ef784f84c9bb",
"shipment_item_id": "32215161-1423-476b-b5f1-d77562002107",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

A join table between fulfillments and shipment_items.

A single fulfillment can have multiple shipment_items and a single shipment_item can only belong to a single fulfillment.

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:
application/json

fulfillment_shipments_items

business_id required	string <uuid> Note: This is a Primary Key.
fulfillment_id required	string <uuid> Note: This is a Primary Key.
shipment_item_id required	string <uuid> Note: This is a Primary Key.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"fulfillment_id": "097dfd3a-2243-488a-bb9e-ef784f84c9bb",
"shipment_item_id": "32215161-1423-476b-b5f1-d77562002107",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

A join table between fulfillments and shipment_items.

A single fulfillment can have multiple shipment_items and a single shipment_item can only belong to a single fulfillment.

query Parameters

business_id	string <uuid>
fulfillment_id	string <uuid>
shipment_item_id	string <uuid>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A join table between fulfillments and shipment_items.

A single fulfillment can have multiple shipment_items and a single shipment_item can only belong to a single fulfillment.

query Parameters

business_id	string <uuid>
fulfillment_id	string <uuid>
shipment_item_id	string <uuid>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

fulfillment_shipments_items

business_id required	string <uuid> Note: This is a Primary Key.
fulfillment_id required	string <uuid> Note: This is a Primary Key.
shipment_item_id required	string <uuid> Note: This is a Primary Key.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"fulfillment_id": "097dfd3a-2243-488a-bb9e-ef784f84c9bb",
"shipment_item_id": "32215161-1423-476b-b5f1-d77562002107",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

business_members

/business_members

query Parameters

business_id	string <uuid>
user_id	string <uuid>
owner	string <boolean>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"owner": false,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/business_members

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:
application/json

business_members

business_id required	string <uuid> Note: This is a Primary Key. This is a Foreign Key to `businesses.id`.
user_id required	string <uuid> Note: This is a Primary Key. This is a Foreign Key to `users.id`.
owner required	boolean <boolean> Default: false
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"owner": false,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/business_members

query Parameters

business_id	string <uuid>
user_id	string <uuid>
owner	string <boolean>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/business_members

query Parameters

business_id	string <uuid>
user_id	string <uuid>
owner	string <boolean>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

business_members

business_id required	string <uuid> Note: This is a Primary Key. This is a Foreign Key to `businesses.id`.
user_id required	string <uuid> Note: This is a Primary Key. This is a Foreign Key to `users.id`.
owner required	boolean <boolean> Default: false
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"owner": false,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

order_line_item_taxes

/order_line_item_taxes

query Parameters

id	string <uuid>
business_id	string <uuid>
order_id	string <uuid>
rate	string <double precision>
price	string <numeric>
title	string <character varying>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"rate": 0,
"price": 0,
"title": "string",
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/order_line_item_taxes

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:
application/json

order_line_item_taxes

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> Note: This is a Foreign Key to `orders.id`.
rate	number <double precision>
price required	number <numeric>
title required	string <character varying> <= 255 characters
external_ids	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"rate": 0,
"price": 0,
"title": "string",
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/order_line_item_taxes

query Parameters

id	string <uuid>
business_id	string <uuid>
order_id	string <uuid>
rate	string <double precision>
price	string <numeric>
title	string <character varying>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/order_line_item_taxes

query Parameters

id	string <uuid>
business_id	string <uuid>
order_id	string <uuid>
rate	string <double precision>
price	string <numeric>
title	string <character varying>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

order_line_item_taxes

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> Note: This is a Foreign Key to `orders.id`.
rate	number <double precision>
price required	number <numeric>
title required	string <character varying> <= 255 characters
external_ids	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"rate": 0,
"price": 0,
"title": "string",
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

refunds

/refunds

query Parameters

id	string <uuid>
business_id	string <uuid>
channel_refund_id	string <character varying>
supplier_refund_id	string <character varying>
order_id	string <uuid>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_refund_id": "string",
"supplier_refund_id": "string",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/refunds

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:
application/json

refunds

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`.
channel_refund_id	string <character varying> <= 255 characters
supplier_refund_id	string <character varying> <= 255 characters
order_id required	string <uuid> Note: This is a Foreign Key to `orders.id`.
external_ids	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_refund_id": "string",
"supplier_refund_id": "string",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/refunds

query Parameters

id	string <uuid>
business_id	string <uuid>
channel_refund_id	string <character varying>
supplier_refund_id	string <character varying>
order_id	string <uuid>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/refunds

query Parameters

id	string <uuid>
business_id	string <uuid>
channel_refund_id	string <character varying>
supplier_refund_id	string <character varying>
order_id	string <uuid>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

refunds

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`.
channel_refund_id	string <character varying> <= 255 characters
supplier_refund_id	string <character varying> <= 255 characters
order_id required	string <uuid> Note: This is a Foreign Key to `orders.id`.
external_ids	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_refund_id": "string",
"supplier_refund_id": "string",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

white_label

/white_label

query Parameters

id	string <uuid>
name	string <public.short_text>
title	string <public.short_text>
favicon_bucket	string <text>
favicon_path	string <text>
logo_light_bucket	string <text>
logo_light_path	string <text>
logo_dark_bucket	string <text>
logo_dark_path	string <text>
logo_url	string <text>
theme	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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"title": "string",
"favicon_bucket": "string",
"favicon_path": "string",
"logo_light_bucket": "string",
"logo_light_path": "string",
"logo_dark_bucket": "string",
"logo_dark_path": "string",
"logo_url": "string",
"theme": null
}
]

shipment_receipt_webhooks

/shipment_receipt_webhooks

query Parameters

id	string <uuid>
business_id	string <uuid>
transaction_id	string <bigint>
shipment_receipt_id	string <uuid>
action	string <text>
status	string <public.webhook_status>
shipment_receipt_json	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"transaction_id": 0,
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"action": "string",
"status": "ready",
"shipment_receipt_json": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/shipment_receipt_webhooks

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:
application/json

shipment_receipt_webhooks

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`.
transaction_id required	integer <bigint>
shipment_receipt_id required	string <uuid>
action required	string <text> Note: This is a Foreign Key to `webhook_actions.id`.
status	string <public.webhook_status> Default: "ready" Enum: "ready" "sent"
shipment_receipt_json	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"transaction_id": 0,
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"action": "string",
"status": "ready",
"shipment_receipt_json": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/shipment_receipt_webhooks

query Parameters

id	string <uuid>
business_id	string <uuid>
transaction_id	string <bigint>
shipment_receipt_id	string <uuid>
action	string <text>
status	string <public.webhook_status>
shipment_receipt_json	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/shipment_receipt_webhooks

query Parameters

id	string <uuid>
business_id	string <uuid>
transaction_id	string <bigint>
shipment_receipt_id	string <uuid>
action	string <text>
status	string <public.webhook_status>
shipment_receipt_json	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

shipment_receipt_webhooks

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`.
transaction_id required	integer <bigint>
shipment_receipt_id required	string <uuid>
action required	string <text> Note: This is a Foreign Key to `webhook_actions.id`.
status	string <public.webhook_status> Default: "ready" Enum: "ready" "sent"
shipment_receipt_json	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"transaction_id": 0,
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"action": "string",
"status": "ready",
"shipment_receipt_json": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

inventory_item_current_quantities

Returns the current quantities for each inventory item at each location.

query Parameters

business_id	string <uuid>
inventory_item_id	string <uuid>
location_id	string <uuid>
available_to_sell	string <bigint>
committed	string <bigint>
on_hand	string <bigint>
on_hold	string <bigint>
on_order	string <bigint>
reserve	string <bigint>
incoming	string <bigint>
unavailable	string <bigint>
available_to_promise	string <bigint>
sku	string <text>
title	string <text>
location	string <text>
location_legacy_id	string <integer>
inventory_item_legacy_id	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

200

Content type

application/json

[{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
"available_to_sell": 0,
"committed": 0,
"on_hand": 0,
"on_hold": 0,
"on_order": 0,
"reserve": 0,
"incoming": 0,
"unavailable": 0,
"available_to_promise": 0,
"sku": "string",
"title": "string",
"location": "string",
"location_legacy_id": 0,
"inventory_item_legacy_id": 0
}
]

shipment_receipts_full

/shipment_receipts_full

query Parameters

id	string <uuid>
business_id	string <uuid>
shipment_number	string <text>
status	string <public.shipment_status>
bill_of_lading	string <text>
order_number	string <text>
external_ids	string <jsonb>
additional_fields	string <jsonb>
carrier	string <text>
service	string <text>
scac	string <text>
tracking_number	string <text>
tracking_urls	string <public.url[]>
ship_by_time	string <date-time>
deliver_by_time	string <date-time>
cancel_by_time	string <date-time>
shipped_time	string <date-time>
received_time	string <date-time>
estimated_arrival_time	string <date-time>
cancelled_time	string <date-time>
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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_number": "string",
"status": "unshipped",
"bill_of_lading": "string",
"order_number": "string",
"external_ids": null,
"additional_fields": null,
"carrier": "string",
"service": "string",
"scac": "string",
"tracking_number": "string",
"tracking_urls": ["string"
],
"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",
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"from_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"to_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"receipts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"received_time": "2019-08-24T14:15:22Z",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"quantity": 0,
"title": "string",
"comment": "string",
"receipt_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"available": true
}
]
}
]
}
]

shipment_package_items

/shipment_package_items

query Parameters

id	string <uuid>
shipment_id	string <uuid>
additional_fields	string <jsonb>
external_ids	string <jsonb>
carton_id	string <text>
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 <numeric>
shipping_cost	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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
]
}
]

variant_webhooks

/variant_webhooks

query Parameters

id	string <uuid>
transaction_id	string <bigint>
product_variant_id	string <uuid>
variant_json	string <jsonb>
options_json	string <jsonb>
tags_json	string <jsonb>
status	string <public.webhook_status>
action	string <text>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"transaction_id": 0,
"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"variant_json": null,
"options_json": null,
"tags_json": null,
"status": "ready",
"action": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/variant_webhooks

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:
application/json

variant_webhooks

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
transaction_id required	integer <bigint>
product_variant_id required	string <uuid> Note: This is a Foreign Key to `product_variants.id`.
variant_json	any <jsonb>
options_json	any <jsonb>
tags_json	any <jsonb>
status	string <public.webhook_status> Default: "ready" Enum: "ready" "sent"
action required	string <text> Note: This is a Foreign Key to `webhook_actions.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"transaction_id": 0,
"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"variant_json": null,
"options_json": null,
"tags_json": null,
"status": "ready",
"action": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/variant_webhooks

query Parameters

id	string <uuid>
transaction_id	string <bigint>
product_variant_id	string <uuid>
variant_json	string <jsonb>
options_json	string <jsonb>
tags_json	string <jsonb>
status	string <public.webhook_status>
action	string <text>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/variant_webhooks

query Parameters

id	string <uuid>
transaction_id	string <bigint>
product_variant_id	string <uuid>
variant_json	string <jsonb>
options_json	string <jsonb>
tags_json	string <jsonb>
status	string <public.webhook_status>
action	string <text>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

variant_webhooks

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
transaction_id required	integer <bigint>
product_variant_id required	string <uuid> Note: This is a Foreign Key to `product_variants.id`.
variant_json	any <jsonb>
options_json	any <jsonb>
tags_json	any <jsonb>
status	string <public.webhook_status> Default: "ready" Enum: "ready" "sent"
action required	string <text> Note: This is a Foreign Key to `webhook_actions.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"transaction_id": 0,
"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"variant_json": null,
"options_json": null,
"tags_json": null,
"status": "ready",
"action": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

product_variants

Detailed information about the variant of a product

query Parameters

id	string <uuid> A generated product variant ID
sku	string <public.short_text> The unique identifier for the product variant
product_id	string <uuid> The product that the variant belongs to
business_id	string <uuid>
cost	string <integer> The maginified cost of the product variant
landed_cost	string <integer> The maginified landed cost of the product variant
price	string <integer> The maginified price of the product variant
wholesale_price	string <integer> The maginified wholesale price of the product variant
image_url	string <text> The image url of the product variant
is_active	string <boolean> Determines whether or not the product variant is active
hs_code	string <public.short_text> The HS code of the product variant
length_mm	string <integer> The length of the product variant in millimeters
width_mm	string <integer> The width of the product variant in millimeters
height_mm	string <integer> The height of the product variant in millimeters
weight_grams	string <integer> The weight of the product variant in grams
country_of_origin	string <public.short_text>
currency_code	string <text> The currency of the product variant
upc	string <text> The UPC of the product variant
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"sku": "string",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"cost": 0,
"landed_cost": 0,
"price": 0,
"wholesale_price": 0,
"image_url": "string",
"is_active": true,
"hs_code": "string",
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"weight_grams": 0,
"country_of_origin": "string",
"currency_code": "string",
"upc": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

Detailed information about the variant of a product

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:
application/json

product_variants

id required	string <uuid> Default: "extensions.uuid_generate_v4()" A generated product variant ID Note: This is a Primary Key.
sku required	string <public.short_text> The unique identifier for the product variant
product_id required	string <uuid> The product that the variant belongs to Note: This is a Foreign Key to `products.id`.
business_id required	string <uuid>
cost	integer <integer> The maginified cost of the product variant
landed_cost	integer <integer> The maginified landed cost of the product variant
price	integer <integer> The maginified price of the product variant
wholesale_price	integer <integer> The maginified wholesale price of the product variant
image_url	string <text> The image url of the product variant
is_active required	boolean <boolean> Default: true Determines whether or not the product variant is active
hs_code	string <public.short_text> The HS code of the product variant
length_mm	integer <integer> The length of the product variant in millimeters
width_mm	integer <integer> The width of the product variant in millimeters
height_mm	integer <integer> The height of the product variant in millimeters
weight_grams	integer <integer> The weight of the product variant in grams
country_of_origin	string <public.short_text>
currency_code required	string <text> The currency of the product variant
upc	string <text> The UPC of the product variant
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"sku": "string",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"cost": 0,
"landed_cost": 0,
"price": 0,
"wholesale_price": 0,
"image_url": "string",
"is_active": true,
"hs_code": "string",
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"weight_grams": 0,
"country_of_origin": "string",
"currency_code": "string",
"upc": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

Detailed information about the variant of a product

query Parameters

id	string <uuid> A generated product variant ID
sku	string <public.short_text> The unique identifier for the product variant
product_id	string <uuid> The product that the variant belongs to
business_id	string <uuid>
cost	string <integer> The maginified cost of the product variant
landed_cost	string <integer> The maginified landed cost of the product variant
price	string <integer> The maginified price of the product variant
wholesale_price	string <integer> The maginified wholesale price of the product variant
image_url	string <text> The image url of the product variant
is_active	string <boolean> Determines whether or not the product variant is active
hs_code	string <public.short_text> The HS code of the product variant
length_mm	string <integer> The length of the product variant in millimeters
width_mm	string <integer> The width of the product variant in millimeters
height_mm	string <integer> The height of the product variant in millimeters
weight_grams	string <integer> The weight of the product variant in grams
country_of_origin	string <public.short_text>
currency_code	string <text> The currency of the product variant
upc	string <text> The UPC of the product variant
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Detailed information about the variant of a product

query Parameters

id	string <uuid> A generated product variant ID
sku	string <public.short_text> The unique identifier for the product variant
product_id	string <uuid> The product that the variant belongs to
business_id	string <uuid>
cost	string <integer> The maginified cost of the product variant
landed_cost	string <integer> The maginified landed cost of the product variant
price	string <integer> The maginified price of the product variant
wholesale_price	string <integer> The maginified wholesale price of the product variant
image_url	string <text> The image url of the product variant
is_active	string <boolean> Determines whether or not the product variant is active
hs_code	string <public.short_text> The HS code of the product variant
length_mm	string <integer> The length of the product variant in millimeters
width_mm	string <integer> The width of the product variant in millimeters
height_mm	string <integer> The height of the product variant in millimeters
weight_grams	string <integer> The weight of the product variant in grams
country_of_origin	string <public.short_text>
currency_code	string <text> The currency of the product variant
upc	string <text> The UPC of the product variant
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

product_variants

id required	string <uuid> Default: "extensions.uuid_generate_v4()" A generated product variant ID Note: This is a Primary Key.
sku required	string <public.short_text> The unique identifier for the product variant
product_id required	string <uuid> The product that the variant belongs to Note: This is a Foreign Key to `products.id`.
business_id required	string <uuid>
cost	integer <integer> The maginified cost of the product variant
landed_cost	integer <integer> The maginified landed cost of the product variant
price	integer <integer> The maginified price of the product variant
wholesale_price	integer <integer> The maginified wholesale price of the product variant
image_url	string <text> The image url of the product variant
is_active required	boolean <boolean> Default: true Determines whether or not the product variant is active
hs_code	string <public.short_text> The HS code of the product variant
length_mm	integer <integer> The length of the product variant in millimeters
width_mm	integer <integer> The width of the product variant in millimeters
height_mm	integer <integer> The height of the product variant in millimeters
weight_grams	integer <integer> The weight of the product variant in grams
country_of_origin	string <public.short_text>
currency_code required	string <text> The currency of the product variant
upc	string <text> The UPC of the product variant
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"sku": "string",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"cost": 0,
"landed_cost": 0,
"price": 0,
"wholesale_price": 0,
"image_url": "string",
"is_active": true,
"hs_code": "string",
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"weight_grams": 0,
"country_of_origin": "string",
"currency_code": "string",
"upc": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

orders

A request of items being purchased, sold or transferred.

query Parameters

id	string <uuid>
business_id	string <uuid>
channel_id	string <uuid> The channel the order was placed on.
customer_id	string <uuid> The customer who placed the order.
billing_address_id	string <uuid>
address_from_id	string <uuid>
address_to_id	string <uuid>
additional_fields	string <jsonb>
external_ids	string <jsonb>
channel_order_id	string <text> The id of the order in the channel, must be unique for a channel.
status	string <public.order_status> The current status of the order, defaults to open.
order_type	string <public.order_type>
purchase_order_number	string <text> The purchase order number of the order, must be unique for a business.
currency_code	string <text> The currency of the order.
subtotal_price	string <integer> The subtotal price of the order.
total_price	string <integer> The total price of the order.
total_shipping_price	string <integer> The total shipping price of the order.
total_shipping_tax	string <integer> The total shipping tax of the order.
total_tax	string <integer> The total tax of the order.
total_grams	string <numeric> The total weight of the order in grams.
purchased_time	string <date-time> The time the order was purchased.
canceled_time	string <date-time> The time the order was canceled.
ships_by_time	string <date-time> The time the order must be shipped by.
canceled_reason	string <text> The reason the order was canceled.
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"address_from_id": "3b7dc3e9-70e5-4927-ae9b-1795367ea198",
"address_to_id": "ad752043-0da5-4526-9d62-2fec8e99eaa2",
"additional_fields": null,
"external_ids": null,
"channel_order_id": "string",
"status": "open",
"order_type": "sales_order",
"purchase_order_number": "string",
"currency_code": "string",
"subtotal_price": 0,
"total_price": 0,
"total_shipping_price": 0,
"total_shipping_tax": 0,
"total_tax": 0,
"total_grams": 0,
"purchased_time": "2019-08-24T14:15:22Z",
"canceled_time": "2019-08-24T14:15:22Z",
"ships_by_time": "2019-08-24T14:15:22Z",
"canceled_reason": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

A request of items being purchased, sold or transferred.

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:
application/json

orders

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`.
channel_id	string <uuid> The channel the order was placed on.
customer_id	string <uuid> The customer who placed the order.
billing_address_id	string <uuid>
address_from_id	string <uuid>
address_to_id	string <uuid>
additional_fields	any <jsonb>
external_ids	any <jsonb>
channel_order_id	string <text> The id of the order in the channel, must be unique for a channel.
status required	string <public.order_status> Default: "open" Enum: "open" "in_progress" "closed" "canceled" "pending" "hold" The current status of the order, defaults to open.
order_type required	string <public.order_type> Default: "sales_order" Enum: "sales_order" "purchase_order" "stock_transfer_order"
purchase_order_number	string <text> The purchase order number of the order, must be unique for a business.
currency_code	string <text> The currency of the order. Note: This is a Foreign Key to `currencies.code`.
subtotal_price	integer <integer> The subtotal price of the order.
total_price	integer <integer> The total price of the order.
total_shipping_price	integer <integer> The total shipping price of the order.
total_shipping_tax	integer <integer> The total shipping tax of the order.
total_tax	integer <integer> The total tax of the order.
total_grams	number <numeric> The total weight of the order in grams.
purchased_time	string <date-time> The time the order was purchased.
canceled_time	string <date-time> The time the order was canceled.
ships_by_time	string <date-time> The time the order must be shipped by.
canceled_reason	string <text> The reason the order was canceled.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"address_from_id": "3b7dc3e9-70e5-4927-ae9b-1795367ea198",
"address_to_id": "ad752043-0da5-4526-9d62-2fec8e99eaa2",
"additional_fields": null,
"external_ids": null,
"channel_order_id": "string",
"status": "open",
"order_type": "sales_order",
"purchase_order_number": "string",
"currency_code": "string",
"subtotal_price": 0,
"total_price": 0,
"total_shipping_price": 0,
"total_shipping_tax": 0,
"total_tax": 0,
"total_grams": 0,
"purchased_time": "2019-08-24T14:15:22Z",
"canceled_time": "2019-08-24T14:15:22Z",
"ships_by_time": "2019-08-24T14:15:22Z",
"canceled_reason": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

A request of items being purchased, sold or transferred.

query Parameters

id	string <uuid>
business_id	string <uuid>
channel_id	string <uuid> The channel the order was placed on.
customer_id	string <uuid> The customer who placed the order.
billing_address_id	string <uuid>
address_from_id	string <uuid>
address_to_id	string <uuid>
additional_fields	string <jsonb>
external_ids	string <jsonb>
channel_order_id	string <text> The id of the order in the channel, must be unique for a channel.
status	string <public.order_status> The current status of the order, defaults to open.
order_type	string <public.order_type>
purchase_order_number	string <text> The purchase order number of the order, must be unique for a business.
currency_code	string <text> The currency of the order.
subtotal_price	string <integer> The subtotal price of the order.
total_price	string <integer> The total price of the order.
total_shipping_price	string <integer> The total shipping price of the order.
total_shipping_tax	string <integer> The total shipping tax of the order.
total_tax	string <integer> The total tax of the order.
total_grams	string <numeric> The total weight of the order in grams.
purchased_time	string <date-time> The time the order was purchased.
canceled_time	string <date-time> The time the order was canceled.
ships_by_time	string <date-time> The time the order must be shipped by.
canceled_reason	string <text> The reason the order was canceled.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A request of items being purchased, sold or transferred.

query Parameters

id	string <uuid>
business_id	string <uuid>
channel_id	string <uuid> The channel the order was placed on.
customer_id	string <uuid> The customer who placed the order.
billing_address_id	string <uuid>
address_from_id	string <uuid>
address_to_id	string <uuid>
additional_fields	string <jsonb>
external_ids	string <jsonb>
channel_order_id	string <text> The id of the order in the channel, must be unique for a channel.
status	string <public.order_status> The current status of the order, defaults to open.
order_type	string <public.order_type>
purchase_order_number	string <text> The purchase order number of the order, must be unique for a business.
currency_code	string <text> The currency of the order.
subtotal_price	string <integer> The subtotal price of the order.
total_price	string <integer> The total price of the order.
total_shipping_price	string <integer> The total shipping price of the order.
total_shipping_tax	string <integer> The total shipping tax of the order.
total_tax	string <integer> The total tax of the order.
total_grams	string <numeric> The total weight of the order in grams.
purchased_time	string <date-time> The time the order was purchased.
canceled_time	string <date-time> The time the order was canceled.
ships_by_time	string <date-time> The time the order must be shipped by.
canceled_reason	string <text> The reason the order was canceled.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

orders

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`.
channel_id	string <uuid> The channel the order was placed on.
customer_id	string <uuid> The customer who placed the order.
billing_address_id	string <uuid>
address_from_id	string <uuid>
address_to_id	string <uuid>
additional_fields	any <jsonb>
external_ids	any <jsonb>
channel_order_id	string <text> The id of the order in the channel, must be unique for a channel.
status required	string <public.order_status> Default: "open" Enum: "open" "in_progress" "closed" "canceled" "pending" "hold" The current status of the order, defaults to open.
order_type required	string <public.order_type> Default: "sales_order" Enum: "sales_order" "purchase_order" "stock_transfer_order"
purchase_order_number	string <text> The purchase order number of the order, must be unique for a business.
currency_code	string <text> The currency of the order. Note: This is a Foreign Key to `currencies.code`.
subtotal_price	integer <integer> The subtotal price of the order.
total_price	integer <integer> The total price of the order.
total_shipping_price	integer <integer> The total shipping price of the order.
total_shipping_tax	integer <integer> The total shipping tax of the order.
total_tax	integer <integer> The total tax of the order.
total_grams	number <numeric> The total weight of the order in grams.
purchased_time	string <date-time> The time the order was purchased.
canceled_time	string <date-time> The time the order was canceled.
ships_by_time	string <date-time> The time the order must be shipped by.
canceled_reason	string <text> The reason the order was canceled.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"address_from_id": "3b7dc3e9-70e5-4927-ae9b-1795367ea198",
"address_to_id": "ad752043-0da5-4526-9d62-2fec8e99eaa2",
"additional_fields": null,
"external_ids": null,
"channel_order_id": "string",
"status": "open",
"order_type": "sales_order",
"purchase_order_number": "string",
"currency_code": "string",
"subtotal_price": 0,
"total_price": 0,
"total_shipping_price": 0,
"total_shipping_tax": 0,
"total_tax": 0,
"total_grams": 0,
"purchased_time": "2019-08-24T14:15:22Z",
"canceled_time": "2019-08-24T14:15:22Z",
"ships_by_time": "2019-08-24T14:15:22Z",
"canceled_reason": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

product_variant_tags

The tags that a product variant has

query Parameters

product_variant_id	string <uuid> The product variant that the tag belongs to
tag_id	string <uuid> The tag that the product variant has
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

The tags 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:
application/json

product_variant_tags

product_variant_id required	string <uuid> The product variant that the tag belongs to Note: This is a Primary Key. This is a Foreign Key to `product_variants.id`.
tag_id required	string <uuid> The tag that the product variant has Note: This is a Primary Key. This is a Foreign Key to `tags.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

The tags that a product variant has

query Parameters

product_variant_id	string <uuid> The product variant that the tag belongs to
tag_id	string <uuid> The tag that the product variant has
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

The tags that a product variant has

query Parameters

product_variant_id	string <uuid> The product variant that the tag belongs to
tag_id	string <uuid> The tag that the product variant has
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

product_variant_tags

product_variant_id required	string <uuid> The product variant that the tag belongs to Note: This is a Primary Key. This is a Foreign Key to `product_variants.id`.
tag_id required	string <uuid> The tag that the product variant has Note: This is a Primary Key. This is a Foreign Key to `tags.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

users

/users

query Parameters

id	string <uuid>
username	string <text>
verified	string <boolean>
supabase_id	string <uuid>
legacy_id	string <bigint>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"username": "string",
"verified": false,
"supabase_id": "cdb70cd1-0ae7-4d24-8bd2-6cb1c529ee36",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/users

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:
application/json

users

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
username required	string <text>
verified required	boolean <boolean> Default: false
supabase_id	string <uuid>
legacy_id	integer <bigint>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"username": "string",
"verified": false,
"supabase_id": "cdb70cd1-0ae7-4d24-8bd2-6cb1c529ee36",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/users

query Parameters

id	string <uuid>
username	string <text>
verified	string <boolean>
supabase_id	string <uuid>
legacy_id	string <bigint>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/users

query Parameters

id	string <uuid>
username	string <text>
verified	string <boolean>
supabase_id	string <uuid>
legacy_id	string <bigint>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

users

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
username required	string <text>
verified required	boolean <boolean> Default: false
supabase_id	string <uuid>
legacy_id	integer <bigint>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"username": "string",
"verified": false,
"supabase_id": "cdb70cd1-0ae7-4d24-8bd2-6cb1c529ee36",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

refund_line_items

/refund_line_items

query Parameters

id	string <uuid>
business_id	string <uuid>
refund_id	string <uuid>
quantity	string <bigint>
order_line_item_id	string <uuid>
order_id	string <uuid>
restock_type_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"refund_id": "63c72644-8ac7-4527-8b49-bb7e9f190cb0",
"quantity": 0,
"order_line_item_id": "e9eed13b-9b09-47d5-b073-7668c23a54da",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"restock_type_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/refund_line_items

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:
application/json

refund_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`.
refund_id required	string <uuid> Note: This is a Foreign Key to `refunds.id`.
quantity	integer <bigint>
order_line_item_id required	string <uuid> Note: This is a Foreign Key to `order_line_items.id`.
order_id required	string <uuid>
restock_type_id	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"refund_id": "63c72644-8ac7-4527-8b49-bb7e9f190cb0",
"quantity": 0,
"order_line_item_id": "e9eed13b-9b09-47d5-b073-7668c23a54da",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"restock_type_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/refund_line_items

query Parameters

id	string <uuid>
business_id	string <uuid>
refund_id	string <uuid>
quantity	string <bigint>
order_line_item_id	string <uuid>
order_id	string <uuid>
restock_type_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/refund_line_items

query Parameters

id	string <uuid>
business_id	string <uuid>
refund_id	string <uuid>
quantity	string <bigint>
order_line_item_id	string <uuid>
order_id	string <uuid>
restock_type_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

refund_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`.
refund_id required	string <uuid> Note: This is a Foreign Key to `refunds.id`.
quantity	integer <bigint>
order_line_item_id required	string <uuid> Note: This is a Foreign Key to `order_line_items.id`.
order_id required	string <uuid>
restock_type_id	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"refund_id": "63c72644-8ac7-4527-8b49-bb7e9f190cb0",
"quantity": 0,
"order_line_item_id": "e9eed13b-9b09-47d5-b073-7668c23a54da",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"restock_type_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

location_addresses

/location_addresses

query Parameters

id	string <uuid>
business_id	string <uuid>
name	string <text>
fulfillment_sla_hours	string <smallint>
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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
}
]

shipment_items

Shipment items are the items that are shipped, can be a child of either a shipment or a shipment carton.

If the shipment item is a child of a shipment carton then it is must be a child of the shipment as well.

query Parameters

id	string <uuid>
business_id	string <uuid>
shipment_id	string <uuid>
shipment_package_id	string <uuid>
inventory_item_id	string <uuid>
additional_fields	string <jsonb>
external_ids	string <jsonb>
line_number	string <smallint> The line number of the shipment determines the order it's displayed in, e.g. 2
quantity	string <integer> Amount of items shipped for this line item, must be positive.
name	string <text>
upc	string <text> The upc of the shipment item
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 <integer>
discounted_price	string <integer>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

Shipment items are the items that are shipped, can be a child of either a shipment or a shipment carton.

If the shipment item is a child of a shipment carton then it is must be a child of the shipment as well.

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:
application/json

shipment_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`.
shipment_id required	string <uuid>
shipment_package_id	string <uuid>
inventory_item_id required	string <uuid>
additional_fields	any <jsonb>
external_ids	any <jsonb>
line_number	integer <smallint> The line number of the shipment determines the order it's displayed in, e.g. 2
quantity required	integer <integer> Amount of items shipped for this line item, must be positive.
name	string <text>
upc	string <text> The upc of the shipment item
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> Note: This is a Foreign Key to `currencies.code`.
unit_price	integer <integer>
discounted_price	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

Shipment items are the items that are shipped, can be a child of either a shipment or a shipment carton.

If the shipment item is a child of a shipment carton then it is must be a child of the shipment as well.

query Parameters

id	string <uuid>
business_id	string <uuid>
shipment_id	string <uuid>
shipment_package_id	string <uuid>
inventory_item_id	string <uuid>
additional_fields	string <jsonb>
external_ids	string <jsonb>
line_number	string <smallint> The line number of the shipment determines the order it's displayed in, e.g. 2
quantity	string <integer> Amount of items shipped for this line item, must be positive.
name	string <text>
upc	string <text> The upc of the shipment item
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 <integer>
discounted_price	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Shipment items are the items that are shipped, can be a child of either a shipment or a shipment carton.

If the shipment item is a child of a shipment carton then it is must be a child of the shipment as well.

query Parameters

id	string <uuid>
business_id	string <uuid>
shipment_id	string <uuid>
shipment_package_id	string <uuid>
inventory_item_id	string <uuid>
additional_fields	string <jsonb>
external_ids	string <jsonb>
line_number	string <smallint> The line number of the shipment determines the order it's displayed in, e.g. 2
quantity	string <integer> Amount of items shipped for this line item, must be positive.
name	string <text>
upc	string <text> The upc of the shipment item
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 <integer>
discounted_price	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

shipment_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`.
shipment_id required	string <uuid>
shipment_package_id	string <uuid>
inventory_item_id required	string <uuid>
additional_fields	any <jsonb>
external_ids	any <jsonb>
line_number	integer <smallint> The line number of the shipment determines the order it's displayed in, e.g. 2
quantity required	integer <integer> Amount of items shipped for this line item, must be positive.
name	string <text>
upc	string <text> The upc of the shipment item
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> Note: This is a Foreign Key to `currencies.code`.
unit_price	integer <integer>
discounted_price	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

refund_line_item_restock_types

/refund_line_item_restock_types

query Parameters

id	string <uuid>
name	string <character varying>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"name": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/refund_line_item_restock_types

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:
application/json

refund_line_item_restock_types

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
name required	string <character varying> <= 12 characters
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"name": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/refund_line_item_restock_types

query Parameters

id	string <uuid>
name	string <character varying>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/refund_line_item_restock_types

query Parameters

id	string <uuid>
name	string <character varying>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

refund_line_item_restock_types

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
name required	string <character varying> <= 12 characters
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"name": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

fulfillments

A fulfillment of an order, must be linked to an order.

query Parameters

id	string <uuid>
business_id	string <uuid> The business the fulfillment belongs to.
location_id	string <uuid>
order_id	string <uuid> The order the fulfillment belongs to.
additional_fields	string <jsonb>
external_ids	string <jsonb>
channel_fulfillment_id	string <text> The id of the fulfillment in the channel, must be unique for a channel.
shipping_company	string <text> The shipping company of the fulfillment, DEPRECATED link to shipment instead.
shipping_method	string <text> The shipping method of the fulfillment, DEPRECATED link to shipment instead.
tracking_number	string <text> The tracking number of the fulfillment, DEPRECATED link to shipment instead.
tracking_urls	string <public.url[]>
status	string <public.fulfillment_status> The current status of the fulfillment, defaults to open.
shipped_time	string <date-time> The time the fulfillment was shipped.
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"additional_fields": null,
"external_ids": null,
"channel_fulfillment_id": "string",
"shipping_company": "string",
"shipping_method": "string",
"tracking_number": "string",
"tracking_urls": ["string"
],
"status": "open",
"shipped_time": "now()",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

A fulfillment of an order, must be linked to 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:
application/json

fulfillments

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
business_id required	string <uuid> The business the fulfillment belongs to. Note: This is a Foreign Key to `businesses.id`.
location_id	string <uuid>
order_id required	string <uuid> The order the fulfillment belongs to.
additional_fields	any <jsonb>
external_ids	any <jsonb>
channel_fulfillment_id	string <text> The id of the fulfillment in the channel, must be unique for a channel.
shipping_company	string <text> The shipping company of the fulfillment, DEPRECATED link to shipment instead.
shipping_method	string <text> The shipping method of the fulfillment, DEPRECATED link to shipment instead.
tracking_number	string <text> The tracking number of the fulfillment, DEPRECATED link to shipment instead.
tracking_urls	Array of strings
status required	string <public.fulfillment_status> Default: "open" Enum: "open" "pending" "success" "canceled" "new" "backorder" The current status of the fulfillment, defaults to open.
shipped_time	string <date-time> Default: "now()" The time the fulfillment was shipped.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"additional_fields": null,
"external_ids": null,
"channel_fulfillment_id": "string",
"shipping_company": "string",
"shipping_method": "string",
"tracking_number": "string",
"tracking_urls": ["string"
],
"status": "open",
"shipped_time": "now()",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

A fulfillment of an order, must be linked to an order.

query Parameters

id	string <uuid>
business_id	string <uuid> The business the fulfillment belongs to.
location_id	string <uuid>
order_id	string <uuid> The order the fulfillment belongs to.
additional_fields	string <jsonb>
external_ids	string <jsonb>
channel_fulfillment_id	string <text> The id of the fulfillment in the channel, must be unique for a channel.
shipping_company	string <text> The shipping company of the fulfillment, DEPRECATED link to shipment instead.
shipping_method	string <text> The shipping method of the fulfillment, DEPRECATED link to shipment instead.
tracking_number	string <text> The tracking number of the fulfillment, DEPRECATED link to shipment instead.
tracking_urls	string <public.url[]>
status	string <public.fulfillment_status> The current status of the fulfillment, defaults to open.
shipped_time	string <date-time> The time the fulfillment was shipped.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A fulfillment of an order, must be linked to an order.

query Parameters

id	string <uuid>
business_id	string <uuid> The business the fulfillment belongs to.
location_id	string <uuid>
order_id	string <uuid> The order the fulfillment belongs to.
additional_fields	string <jsonb>
external_ids	string <jsonb>
channel_fulfillment_id	string <text> The id of the fulfillment in the channel, must be unique for a channel.
shipping_company	string <text> The shipping company of the fulfillment, DEPRECATED link to shipment instead.
shipping_method	string <text> The shipping method of the fulfillment, DEPRECATED link to shipment instead.
tracking_number	string <text> The tracking number of the fulfillment, DEPRECATED link to shipment instead.
tracking_urls	string <public.url[]>
status	string <public.fulfillment_status> The current status of the fulfillment, defaults to open.
shipped_time	string <date-time> The time the fulfillment was shipped.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

fulfillments

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
business_id required	string <uuid> The business the fulfillment belongs to. Note: This is a Foreign Key to `businesses.id`.
location_id	string <uuid>
order_id required	string <uuid> The order the fulfillment belongs to.
additional_fields	any <jsonb>
external_ids	any <jsonb>
channel_fulfillment_id	string <text> The id of the fulfillment in the channel, must be unique for a channel.
shipping_company	string <text> The shipping company of the fulfillment, DEPRECATED link to shipment instead.
shipping_method	string <text> The shipping method of the fulfillment, DEPRECATED link to shipment instead.
tracking_number	string <text> The tracking number of the fulfillment, DEPRECATED link to shipment instead.
tracking_urls	Array of strings
status required	string <public.fulfillment_status> Default: "open" Enum: "open" "pending" "success" "canceled" "new" "backorder" The current status of the fulfillment, defaults to open.
shipped_time	string <date-time> Default: "now()" The time the fulfillment was shipped.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"additional_fields": null,
"external_ids": null,
"channel_fulfillment_id": "string",
"shipping_company": "string",
"shipping_method": "string",
"tracking_number": "string",
"tracking_urls": ["string"
],
"status": "open",
"shipped_time": "now()",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

header Parameters

Range	string Limiting and Pagination
Range-Unit	string Default: items Limiting and Pagination
Prefer	string Value: "count=none" Preference

Responses

Response samples

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"webhook_configuration_id": "67120585-2b10-45a9-a8c8-4c2c3254db79",
"action": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

/webhook_configuration_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:
application/json

webhook_configuration_actions

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
webhook_configuration_id required	string <uuid> Note: This is a Foreign Key to `webhook_configurations.id`.
action required	string <text> Note: This is a Foreign Key to `webhook_actions.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"webhook_configuration_id": "67120585-2b10-45a9-a8c8-4c2c3254db79",
"action": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

/webhook_configuration_actions

query Parameters

id	string <uuid>
webhook_configuration_id	string <uuid>
action	string <text>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/webhook_configuration_actions

query Parameters

id	string <uuid>
webhook_configuration_id	string <uuid>
action	string <text>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

webhook_configuration_actions

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
webhook_configuration_id required	string <uuid> Note: This is a Foreign Key to `webhook_configurations.id`.
action required	string <text> Note: This is a Foreign Key to `webhook_actions.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"webhook_configuration_id": "67120585-2b10-45a9-a8c8-4c2c3254db79",
"action": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

customers

A customer that can be referenced by an order, email is optional but cannot be duplicated for a business.

query Parameters

id	string <uuid>
business_id	string <uuid>
email	string <public.email> The email of the customer cannot be duplicated for a business.
first_name	string <text> The first name of the customer.
last_name	string <text> The last name of the customer.
name	string <text> The full name of the customer, defaults to the concatenation of first_name and last_name.
phone	string <text> The phone number of the customer.
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

A customer that can be referenced by an order, email is optional but cannot be duplicated for a business.

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:
application/json

customers

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`.
email	string <public.email> The email of the customer cannot be duplicated for a business.
first_name	string <text> The first name of the customer.
last_name	string <text> The last name of the customer.
name	string <text> The full name of the customer, defaults to the concatenation of first_name and last_name.
phone	string <text> The phone number of the customer.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

A customer that can be referenced by an order, email is optional but cannot be duplicated for a business.

query Parameters

id	string <uuid>
business_id	string <uuid>
email	string <public.email> The email of the customer cannot be duplicated for a business.
first_name	string <text> The first name of the customer.
last_name	string <text> The last name of the customer.
name	string <text> The full name of the customer, defaults to the concatenation of first_name and last_name.
phone	string <text> The phone number of the customer.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A customer that can be referenced by an order, email is optional but cannot be duplicated for a business.

query Parameters

id	string <uuid>
business_id	string <uuid>
email	string <public.email> The email of the customer cannot be duplicated for a business.
first_name	string <text> The first name of the customer.
last_name	string <text> The last name of the customer.
name	string <text> The full name of the customer, defaults to the concatenation of first_name and last_name.
phone	string <text> The phone number of the customer.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

customers

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`.
email	string <public.email> The email of the customer cannot be duplicated for a business.
first_name	string <text> The first name of the customer.
last_name	string <text> The last name of the customer.
name	string <text> The full name of the customer, defaults to the concatenation of first_name and last_name.
phone	string <text> The phone number of the customer.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

header Parameters

Range	string Limiting and Pagination
Range-Unit	string Default: items Limiting and Pagination
Prefer	string Value: "count=none" Preference

Responses

Response samples

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"fulfillment_id": "097dfd3a-2243-488a-bb9e-ef784f84c9bb",
"order_line_item_id": "e9eed13b-9b09-47d5-b073-7668c23a54da",
"quantity": 0,
"additional_fields": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

A line item in a fulfillment.

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:
application/json

fulfillment_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`.
fulfillment_id required	string <uuid> The fulfillment the line item belongs to.
order_line_item_id required	string <uuid> The order line item the fulfillment line item belongs to.
quantity required	integer <integer> The quantity of the line item.
additional_fields	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"fulfillment_id": "097dfd3a-2243-488a-bb9e-ef784f84c9bb",
"order_line_item_id": "e9eed13b-9b09-47d5-b073-7668c23a54da",
"quantity": 0,
"additional_fields": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

A line item in a fulfillment.

query Parameters

id	string <uuid>
business_id	string <uuid>
fulfillment_id	string <uuid> The fulfillment the line item belongs to.
order_line_item_id	string <uuid> The order line item the fulfillment line item belongs to.
quantity	string <integer> The quantity of the line item.
additional_fields	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A line item in a fulfillment.

query Parameters

id	string <uuid>
business_id	string <uuid>
fulfillment_id	string <uuid> The fulfillment the line item belongs to.
order_line_item_id	string <uuid> The order line item the fulfillment line item belongs to.
quantity	string <integer> The quantity of the line item.
additional_fields	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

fulfillment_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`.
fulfillment_id required	string <uuid> The fulfillment the line item belongs to.
order_line_item_id required	string <uuid> The order line item the fulfillment line item belongs to.
quantity required	integer <integer> The quantity of the line item.
additional_fields	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"fulfillment_id": "097dfd3a-2243-488a-bb9e-ef784f84c9bb",
"order_line_item_id": "e9eed13b-9b09-47d5-b073-7668c23a54da",
"quantity": 0,
"additional_fields": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

standard_product_variant_options

/standard_product_variant_options

query Parameters

product_variant_id	string <uuid>
business_id	string <uuid>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_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

200

Content type

application/json

[{"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"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"
}
]

/standard_product_variant_options

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:
application/json

standard_product_variant_options

product_variant_id	string <uuid> Note: This is a Primary Key.
business_id	string <uuid>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>

Responses

Request samples

Payload

Content type

application/json

{"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"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"
}

/standard_product_variant_options

query Parameters

product_variant_id	string <uuid>
business_id	string <uuid>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/standard_product_variant_options

query Parameters

product_variant_id	string <uuid>
business_id	string <uuid>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

standard_product_variant_options

product_variant_id	string <uuid> Note: This is a Primary Key.
business_id	string <uuid>
option_name_1	string <public.short_text>
option_value_1	string <public.short_text>
option_name_2	string <public.short_text>
option_value_2	string <public.short_text>
option_name_3	string <public.short_text>
option_value_3	string <public.short_text>
option_name_4	string <public.short_text>
option_value_4	string <public.short_text>
option_name_5	string <public.short_text>
option_value_5	string <public.short_text>
option_name_6	string <public.short_text>
option_value_6	string <public.short_text>

Responses

Request samples

Payload

Content type

application/json

{"product_variant_id": "3346b03a-4660-4dfb-b5d0-e13608e6ced8",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"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"
}

shipment_receipts

Record of receiving a shipment

query Parameters

id	string <uuid> Unique identifier for the shipment receipt
shipment_id	string <uuid> The shipment that this receipt is for
business_id	string <uuid> The business that this receipt is for
received_time	string <date-time> The time the shipment was received
completed_time	string <date-time> The time the shipment was completed, if null the shipment is not complete. Once this value is set no further changes to the receipt are allowed and this receipt is considered closed.
additional_fields	string <jsonb>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"received_time": "now()",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

Record of receiving a shipment

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:
application/json

shipment_receipts

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Unique identifier for the shipment receipt Note: This is a Primary Key.
shipment_id required	string <uuid> The shipment that this receipt is for
business_id required	string <uuid> The business that this receipt is for Note: This is a Foreign Key to `businesses.id`.
received_time required	string <date-time> Default: "now()" The time the shipment was received
completed_time	string <date-time> The time the shipment was completed, if null the shipment is not complete. Once this value is set no further changes to the receipt are allowed and this receipt is considered closed.
additional_fields	any <jsonb>
external_ids	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"received_time": "now()",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

Record of receiving a shipment

query Parameters

id	string <uuid> Unique identifier for the shipment receipt
shipment_id	string <uuid> The shipment that this receipt is for
business_id	string <uuid> The business that this receipt is for
received_time	string <date-time> The time the shipment was received
completed_time	string <date-time> The time the shipment was completed, if null the shipment is not complete. Once this value is set no further changes to the receipt are allowed and this receipt is considered closed.
additional_fields	string <jsonb>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Record of receiving a shipment

query Parameters

id	string <uuid> Unique identifier for the shipment receipt
shipment_id	string <uuid> The shipment that this receipt is for
business_id	string <uuid> The business that this receipt is for
received_time	string <date-time> The time the shipment was received
completed_time	string <date-time> The time the shipment was completed, if null the shipment is not complete. Once this value is set no further changes to the receipt are allowed and this receipt is considered closed.
additional_fields	string <jsonb>
external_ids	string <jsonb>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

shipment_receipts

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Unique identifier for the shipment receipt Note: This is a Primary Key.
shipment_id required	string <uuid> The shipment that this receipt is for
business_id required	string <uuid> The business that this receipt is for Note: This is a Foreign Key to `businesses.id`.
received_time required	string <date-time> Default: "now()" The time the shipment was received
completed_time	string <date-time> The time the shipment was completed, if null the shipment is not complete. Once this value is set no further changes to the receipt are allowed and this receipt is considered closed.
additional_fields	any <jsonb>
external_ids	any <jsonb>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"received_time": "now()",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

addresses

An address, can be linked to a location.

query Parameters

id	string <uuid>
business_id	string <uuid> The business the address belongs to.
external_ids	string <jsonb>
name	string <text> The name of the address, used for printing on labels.
address_1	string <text> The first line of the address.
address_2	string <text> The second line of the address.
address_3	string <text> The third line of the address.
city	string <text> The city of the address.
province	string <text> The province of the address.
province_code	string <text> The province code of the address.
country	string <text> The country of the address.
country_code	string <text> The country code of the address.
postal_code	string <text> The postal code of the address.
contact_name	string <text> The contact name of the address.
contact_phone	string <text> The contact phone of the address.
contact_email	string <public.email> The contact email of the address.
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

An address, can be linked to a location.

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:
application/json

addresses

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
business_id required	string <uuid> The business the address belongs to. Note: This is a Foreign Key to `businesses.id`.
external_ids	any <jsonb>
name	string <text> The name of the address, used for printing on labels.
address_1	string <text> The first line of the address.
address_2	string <text> The second line of the address.
address_3	string <text> The third line of the address.
city	string <text> The city of the address.
province	string <text> The province of the address.
province_code	string <text> The province code of the address.
country	string <text> The country of the address.
country_code	string <text> The country code of the address.
postal_code	string <text> The postal code of the address.
contact_name	string <text> The contact name of the address.
contact_phone	string <text> The contact phone of the address.
contact_email	string <public.email> The contact email of the address.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

An address, can be linked to a location.

query Parameters

id	string <uuid>
business_id	string <uuid> The business the address belongs to.
external_ids	string <jsonb>
name	string <text> The name of the address, used for printing on labels.
address_1	string <text> The first line of the address.
address_2	string <text> The second line of the address.
address_3	string <text> The third line of the address.
city	string <text> The city of the address.
province	string <text> The province of the address.
province_code	string <text> The province code of the address.
country	string <text> The country of the address.
country_code	string <text> The country code of the address.
postal_code	string <text> The postal code of the address.
contact_name	string <text> The contact name of the address.
contact_phone	string <text> The contact phone of the address.
contact_email	string <public.email> The contact email of the address.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

An address, can be linked to a location.

query Parameters

id	string <uuid>
business_id	string <uuid> The business the address belongs to.
external_ids	string <jsonb>
name	string <text> The name of the address, used for printing on labels.
address_1	string <text> The first line of the address.
address_2	string <text> The second line of the address.
address_3	string <text> The third line of the address.
city	string <text> The city of the address.
province	string <text> The province of the address.
province_code	string <text> The province code of the address.
country	string <text> The country of the address.
country_code	string <text> The country code of the address.
postal_code	string <text> The postal code of the address.
contact_name	string <text> The contact name of the address.
contact_phone	string <text> The contact phone of the address.
contact_email	string <public.email> The contact email of the address.
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

addresses

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
business_id required	string <uuid> The business the address belongs to. Note: This is a Foreign Key to `businesses.id`.
external_ids	any <jsonb>
name	string <text> The name of the address, used for printing on labels.
address_1	string <text> The first line of the address.
address_2	string <text> The second line of the address.
address_3	string <text> The third line of the address.
city	string <text> The city of the address.
province	string <text> The province of the address.
province_code	string <text> The province code of the address.
country	string <text> The country of the address.
country_code	string <text> The country code of the address.
postal_code	string <text> The postal code of the address.
contact_name	string <text> The contact name of the address.
contact_phone	string <text> The contact phone of the address.
contact_email	string <public.email> The contact email of the address.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

inventory_items

An inventory item is a product that can be sold.

query Parameters

id	string <uuid>
sku	string <text> The SKU of the inventory item, must be unique for a business.
title	string <text> The title of the inventory item.
business_id	string <uuid>
legacy_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"sku": "string",
"title": "string",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

An inventory item is a product that can be sold.

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:
application/json

inventory_items

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
sku required	string <text> The SKU of the inventory item, must be unique for a business.
title	string <text> The title of the inventory item.
business_id required	string <uuid> Note: This is a Foreign Key to `businesses.id`.
legacy_id	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"sku": "string",
"title": "string",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

An inventory item is a product that can be sold.

query Parameters

id	string <uuid>
sku	string <text> The SKU of the inventory item, must be unique for a business.
title	string <text> The title of the inventory item.
business_id	string <uuid>
legacy_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

An inventory item is a product that can be sold.

query Parameters

id	string <uuid>
sku	string <text> The SKU of the inventory item, must be unique for a business.
title	string <text> The title of the inventory item.
business_id	string <uuid>
legacy_id	string <integer>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

inventory_items

id required	string <uuid> Default: "extensions.uuid_generate_v4()" Note: This is a Primary Key.
sku required	string <text> The SKU of the inventory item, must be unique for a business.
title	string <text> The title of the inventory item.
business_id required	string <uuid> Note: This is a Foreign Key to `businesses.id`.
legacy_id	integer <integer>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"sku": "string",
"title": "string",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

product_tags

The tags that a product has

query Parameters

product_id	string <uuid> The product that the tag belongs to
tag_id	string <uuid> The tag that the product has
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

The tags that a product 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:
application/json

product_tags

product_id required	string <uuid> The product that the tag belongs to Note: This is a Primary Key. This is a Foreign Key to `products.id`.
tag_id required	string <uuid> The tag that the product has Note: This is a Primary Key. This is a Foreign Key to `tags.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

The tags that a product has

query Parameters

product_id	string <uuid> The product that the tag belongs to
tag_id	string <uuid> The tag that the product has
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

The tags that a product has

query Parameters

product_id	string <uuid> The product that the tag belongs to
tag_id	string <uuid> The tag that the product has
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

product_tags

product_id required	string <uuid> The product that the tag belongs to Note: This is a Primary Key. This is a Foreign Key to `products.id`.
tag_id required	string <uuid> The tag that the product has Note: This is a Primary Key. This is a Foreign Key to `tags.id`.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

locations

A location is a physical location where orders can be fulfilled. It can also be a virtual location that aggregates many physical locations.

query Parameters

id	string <uuid>
business_id	string <uuid>
name	string <text> The name of the location, must be unique for a business.
fulfillment_sla_hours	string <smallint> The fulfillment service level agreement in hours, cannot be negative or 0.
legacy_id	string <integer>
shipping_address_id	string <uuid>
billing_address_id	string <uuid>
creation_time	string <date-time>
update_time	string <date-time>
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

200

Content type

application/json

[{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"legacy_id": 0,
"shipping_address_id": "cfb5f13a-388c-401e-be3f-ff8f3abcd015",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
]

A location is a physical location where orders can be fulfilled. It can also be a virtual location that aggregates many physical locations.

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:
application/json

locations

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`.
name required	string <text> The name of the location, must be unique for a business.
fulfillment_sla_hours	integer <smallint> The fulfillment service level agreement in hours, cannot be negative or 0.
legacy_id	integer <integer>
shipping_address_id	string <uuid>
billing_address_id	string <uuid>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"legacy_id": 0,
"shipping_address_id": "cfb5f13a-388c-401e-be3f-ff8f3abcd015",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

A location is a physical location where orders can be fulfilled. It can also be a virtual location that aggregates many physical locations.

query Parameters

id	string <uuid>
business_id	string <uuid>
name	string <text> The name of the location, must be unique for a business.
fulfillment_sla_hours	string <smallint> The fulfillment service level agreement in hours, cannot be negative or 0.
legacy_id	string <integer>
shipping_address_id	string <uuid>
billing_address_id	string <uuid>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

A location is a physical location where orders can be fulfilled. It can also be a virtual location that aggregates many physical locations.

query Parameters

id	string <uuid>
business_id	string <uuid>
name	string <text> The name of the location, must be unique for a business.
fulfillment_sla_hours	string <smallint> The fulfillment service level agreement in hours, cannot be negative or 0.
legacy_id	string <integer>
shipping_address_id	string <uuid>
billing_address_id	string <uuid>
creation_time	string <date-time>
update_time	string <date-time>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

locations

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`.
name required	string <text> The name of the location, must be unique for a business.
fulfillment_sla_hours	integer <smallint> The fulfillment service level agreement in hours, cannot be negative or 0.
legacy_id	integer <integer>
shipping_address_id	string <uuid>
billing_address_id	string <uuid>
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"legacy_id": 0,
"shipping_address_id": "cfb5f13a-388c-401e-be3f-ff8f3abcd015",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}

system_permissions

/system_permissions

query Parameters

business_id	string <uuid>
permission	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

200

Content type

application/json

[{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"permission": "string"
}
]

/system_permissions

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:
application/json

system_permissions

business_id	string <uuid> Note: This is a Foreign Key to `businesses.id`.
permission	string <text>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"permission": "string"
}

/system_permissions

query Parameters

business_id	string <uuid>
permission	string <text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/system_permissions

query Parameters

business_id	string <uuid>
permission	string <text>

header Parameters

Prefer

string

Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:
application/json

system_permissions

business_id	string <uuid> Note: This is a Foreign Key to `businesses.id`.
permission	string <text>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"permission": "string"
}

(rpc) upsert_location

Upsert is short for insert or update.

First it will attempt to find the best location match based on the following criteria in order:

If id is specified, it will search and return the address with the matching id and ignore all other criteria
If name is specified, it will return the address with the matching name

If no location is found or multiple are found on that criteria, it will create a new one. If merge is true (defaults to false), it will merge the found location with the location argument. Merge will keep the not null values from the found address and overwrite the null values with the address passed in.

Note : There is a legacy_id field on locations that is not updated on purpose. This is because the legacy_id is used to map to the legacy system and should not be changed.

query Parameters

patch

boolean <boolean>

Responses

Upsert is short for insert or update.

First it will attempt to find the best location match based on the following criteria in order:

If id is specified, it will search and return the address with the matching id and ignore all other criteria
If name is specified, it will return the address with the matching name

If no location is found or multiple are found on that criteria, it will create a new one. If merge is true (defaults to false), it will merge the found location with the location argument. Merge will keep the not null values from the found address and overwrite the null values with the address passed in.

Note : There is a legacy_id field on locations that is not updated on purpose. This is because the legacy_id is used to map to the legacy system and should not be changed.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

required	object (locations) A location is a physical location where orders can be fulfilled. It can also be a virtual location that aggregates many physical locations.
patch	boolean <boolean>

Responses

Request samples

Payload

Content type

application/json

{"location": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"legacy_id": 0,
"shipping_address_id": "cfb5f13a-388c-401e-be3f-ff8f3abcd015",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"patch": true
}

(rpc) postgres_fdw_get_connections

/rpc/postgres_fdw_get_connections

Responses

/rpc/postgres_fdw_get_connections

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

(rpc) highlight_search_inventory_items

Searches inventory items including the highlighted match document.

query Parameters

query_text

required

string <text>

Responses

Searches inventory items including the highlighted match document.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

query_text

required

string <text>

Responses

Request samples

Payload

Content type

application/json

{"query_text": "string"
}

(rpc) login_api_account

Login to an api account and get a jwt token. The token will be valid for 4 hours, if nothing is returned then the account does not exist or the secret is incorrect.

query Parameters

account_id required	string <uuid>
secret required	string <text>

Responses

Login to an api account and get a jwt token. The token will be valid for 4 hours, if nothing is returned then the account does not exist or the secret is incorrect.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

account_id required	string <uuid>
secret required	string <text>

Responses

Request samples

Payload

Content type

application/json

{"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"secret": "string"
}

(rpc) apply_categories

/rpc/apply_categories

query Parameters

p_product_id required	string <uuid>
p_business_id required	string <uuid>
p_category_1 required	string <short_text>
p_category_2 required	string <short_text>
p_category_3 required	string <short_text>
p_category_4 required	string <short_text>
p_category_5 required	string <short_text>
p_category_6 required	string <short_text>

Responses

/rpc/apply_categories

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

p_business_id required	string <uuid>
p_category_1 required	string <short_text>
p_category_2 required	string <short_text>
p_category_3 required	string <short_text>
p_category_4 required	string <short_text>
p_category_5 required	string <short_text>
p_category_6 required	string <short_text>
p_product_id required	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"p_business_id": "f5e8179b-8d10-4ed3-b41c-1e8bdbd6861a",
"p_category_1": "string",
"p_category_2": "string",
"p_category_3": "string",
"p_category_4": "string",
"p_category_5": "string",
"p_category_6": "string",
"p_product_id": "2f5608fe-c5e7-4c2a-b42a-756eabe40a00"
}

(rpc) upsert_orders_full

/rpc/upsert_orders_full

Responses

/rpc/upsert_orders_full

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

required

object (orders_full)

id	string <uuid> Note: This is a Primary Key.
business_id	string <uuid> Note: This is a Foreign Key to `businesses.id`.
channel_id	string <uuid>
customer_id	string <uuid>
	object (addresses) An address, can be linked to a location.
	object (addresses) An address, can be linked to a location.
	object (addresses) An address, can be linked to a location.
external_ids	any <jsonb>
channel_order_id	string <text>
additional_fields	any <jsonb>
status	string <public.order_status> Enum: "open" "in_progress" "closed" "canceled" "pending" "hold"
order_type	string <public.order_type> Enum: "sales_order" "purchase_order" "stock_transfer_order"
purchase_order_number	string <text>
currency_code	string <text> Note: This is a Foreign Key to `currencies.code`.
subtotal_price	integer <integer>
total_price	integer <integer>
total_shipping_price	integer <integer>
total_tax	integer <integer>
total_shipping_tax	integer <integer>
total_grams	number <numeric>
purchased_time	string <date-time>
canceled_time	string <date-time>
ships_by_time	string <date-time>
canceled_reason	string <text>

Responses

Request samples

Payload

Content type

application/json

{"order_to_upsert": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"address_to": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"address_from": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"external_ids": null,
"channel_order_id": "string",
"additional_fields": null,
"status": "open",
"order_type": "sales_order",
"purchase_order_number": "string",
"currency_code": "string",
"subtotal_price": 0,
"total_price": 0,
"total_shipping_price": 0,
"total_tax": 0,
"total_shipping_tax": 0,
"total_grams": 0,
"purchased_time": "2019-08-24T14:15:22Z",
"canceled_time": "2019-08-24T14:15:22Z",
"ships_by_time": "2019-08-24T14:15:22Z",
"canceled_reason": "string"
}
}

(rpc) upsert_order

/rpc/upsert_order

Responses

/rpc/upsert_order

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

required

object (orders)

A request of items being purchased, sold or transferred.

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`.
channel_id	string <uuid> The channel the order was placed on.
customer_id	string <uuid> The customer who placed the order.
billing_address_id	string <uuid>
address_from_id	string <uuid>
address_to_id	string <uuid>
additional_fields	any <jsonb>
external_ids	any <jsonb>
channel_order_id	string <text> The id of the order in the channel, must be unique for a channel.
status required	string <public.order_status> Default: "open" Enum: "open" "in_progress" "closed" "canceled" "pending" "hold" The current status of the order, defaults to open.
order_type required	string <public.order_type> Default: "sales_order" Enum: "sales_order" "purchase_order" "stock_transfer_order"
purchase_order_number	string <text> The purchase order number of the order, must be unique for a business.
currency_code	string <text> The currency of the order. Note: This is a Foreign Key to `currencies.code`.
subtotal_price	integer <integer> The subtotal price of the order.
total_price	integer <integer> The total price of the order.
total_shipping_price	integer <integer> The total shipping price of the order.
total_shipping_tax	integer <integer> The total shipping tax of the order.
total_tax	integer <integer> The total tax of the order.
total_grams	number <numeric> The total weight of the order in grams.
purchased_time	string <date-time> The time the order was purchased.
canceled_time	string <date-time> The time the order was canceled.
ships_by_time	string <date-time> The time the order must be shipped by.
canceled_reason	string <text> The reason the order was canceled.
creation_time	string <date-time> Default: "now()"
update_time	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"order_to_upsert": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
"address_from_id": "3b7dc3e9-70e5-4927-ae9b-1795367ea198",
"address_to_id": "ad752043-0da5-4526-9d62-2fec8e99eaa2",
"additional_fields": null,
"external_ids": null,
"channel_order_id": "string",
"status": "open",
"order_type": "sales_order",
"purchase_order_number": "string",
"currency_code": "string",
"subtotal_price": 0,
"total_price": 0,
"total_shipping_price": 0,
"total_shipping_tax": 0,
"total_tax": 0,
"total_grams": 0,
"purchased_time": "2019-08-24T14:15:22Z",
"canceled_time": "2019-08-24T14:15:22Z",
"ships_by_time": "2019-08-24T14:15:22Z",
"canceled_reason": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
}

(rpc) create_webhook_portal_magic_link

/rpc/create_webhook_portal_magic_link

query Parameters

business_id

required

string <uuid>

Responses

/rpc/create_webhook_portal_magic_link

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

business_id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c"
}

(rpc) highlight_search_orders

Searches orders including the highlighted match document.

query Parameters

query_text

required

string <text>

Responses

Searches orders including the highlighted match document.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

query_text

required

string <text>

Responses

Request samples

Payload

Content type

application/json

{"query_text": "string"
}

(rpc) upsert_inventory_item

Upsert is short for insert or update.

First it will attempt to find the best inventory item match based on the following criteria in order:

If id is specified, it will search and return the inventory item with the matching id and ignore all other criteria
If sku is specified, it will return the inventory item with the matching sku

If no inventory item is found or multiple are found on that criteria, it will create a new one. If merge is true (defaults to false), it will merge the found inventory item with the inventory_item argument. Merge will keep the not null values from the found inventory item and overwrite the null values with the inventory item passed in.

query Parameters

patch

boolean <boolean>

Responses

Upsert is short for insert or update.

First it will attempt to find the best inventory item match based on the following criteria in order:

If id is specified, it will search and return the inventory item with the matching id and ignore all other criteria
If sku is specified, it will return the inventory item with the matching sku

If no inventory item is found or multiple are found on that criteria, it will create a new one. If merge is true (defaults to false), it will merge the found inventory item with the inventory_item argument. Merge will keep the not null values from the found inventory item and overwrite the null values with the inventory item passed in.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

required	object (inventory_items) An inventory item is a product that can be sold.
patch	boolean <boolean>

Responses

Request samples

Payload

Content type

application/json

{"inventory_item": {"id": "extensions.uuid_generate_v4()",
"sku": "string",
"title": "string",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"legacy_id": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"patch": true
}

(rpc) is_system_permission_enabled_for_business

/rpc/is_system_permission_enabled_for_business

query Parameters

p_business_id required	string <uuid>
p_permission required	string <text>

Responses

/rpc/is_system_permission_enabled_for_business

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

p_business_id required	string <uuid>
p_permission required	string <text>

Responses

Request samples

Payload

Content type

application/json

{"p_business_id": "f5e8179b-8d10-4ed3-b41c-1e8bdbd6861a",
"p_permission": "string"
}

(rpc) inventory_presell

Determine inventory availability for a SKU on a channel.

query Parameters

channel_id required	string <uuid>
sku required	string <text>

Responses

Determine inventory availability for a SKU on a channel.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

channel_id required	string <uuid>
sku required	string <text>

Responses

Request samples

Payload

Content type

application/json

{"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"sku": "string"
}

(rpc) upsert_shipment_receipts_with_items

/rpc/upsert_shipment_receipts_with_items

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment_receipts_with_items

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_receipts_with_items)

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_receipts_with_item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"received_time": "2019-08-24T14:15:22Z",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"quantity": 0,
"title": "string",
"comment": "string",
"receipt_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"available": true
}
]
}
}

(rpc) upsert_shipment_package

/rpc/upsert_shipment_package

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment_package

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_packages) Shipment packages are the physical packages that are shipped.

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_package": {"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,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
}

(rpc) highlight_search_locations

Searches locations including the highlighted match document. Search is eventually consistent as it is updated every 5-15 minutes.

query Parameters

query_text

required

string <text>

Responses

Searches locations including the highlighted match document. Search is eventually consistent as it is updated every 5-15 minutes.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

query_text

required

string <text>

Responses

Request samples

Payload

Content type

application/json

{"query_text": "string"
}

(rpc) is_writeable_order_type

/rpc/is_writeable_order_type

query Parameters

p_order_id

required

string <uuid>

Responses

/rpc/is_writeable_order_type

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

p_order_id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"p_order_id": "c3070f3d-d658-47e6-956d-dcb0ee3c8f2c"
}

(rpc) highlight_search_shipment_receipts

Searches shipment receipts including the highlighted match document. Search is eventually consistent as it is updated every 5-15 minutes.

query Parameters

query_text

required

string <text>

Responses

Searches shipment receipts including the highlighted match document. Search is eventually consistent as it is updated every 5-15 minutes.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

query_text

required

string <text>

Responses

Request samples

Payload

Content type

application/json

{"query_text": "string"
}

(rpc) highlight_address_search

Highlights the address fields that match the search query

query Parameters

query_text

required

string <text>

Responses

Highlights the address fields that match the search query

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

query_text

required

string <text>

Responses

Request samples

Payload

Content type

application/json

{"query_text": "string"
}

(rpc) unmagnify

/rpc/unmagnify

query Parameters

currency_code required	string <currency_code>
magnfiedamount required	number <numeric>

Responses

/rpc/unmagnify

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

currency_code required	string <currency_code>
magnfiedamount required	number <numeric>

Responses

Request samples

Payload

Content type

application/json

{"currency_code": "string",
"magnfiedamount": 0
}

(rpc) populate_sales_orders_from_legacy

/rpc/populate_sales_orders_from_legacy

Responses

/rpc/populate_sales_orders_from_legacy

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

(rpc) highlight_search_shipments

Searches shipments including the highlighted match document.

query Parameters

query_text

required

string <text>

Responses

Searches shipments including the highlighted match document.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

query_text

required

string <text>

Responses

Request samples

Payload

Content type

application/json

{"query_text": "string"
}

(rpc) create_api_account

Create an api account for a business, api secret is returned once and cannot be recovered if lost.

query Parameters

business_id required	string <uuid>
name required	string <text>

Responses

Create an api account for a business, api secret is returned once and cannot be recovered if lost.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

business_id required	string <uuid>
name required	string <text>

Responses

Request samples

Payload

Content type

application/json

{"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string"
}

(rpc) upsert_address

Upsert is short for insert or update.

First it will attempt to find the best address match based on the following criteria in order:

If id is specified, it will search and return the address with the matching id and ignore all other criteria
If external_ids is specified, it will return the address with the matching external_ids or a superset of the external_ids
If name is specified, it will return the address with the matching name

If no address is found or multiple are found on that criteria, it will create a new one. If merge is true (defaults to false), it will merge the found address with the address argument. Merge will keep the not null values from the found address and overwrite the null values with the address passed in.

query Parameters

patch

boolean <boolean>

Responses

Upsert is short for insert or update.

First it will attempt to find the best address match based on the following criteria in order:

If id is specified, it will search and return the address with the matching id and ignore all other criteria
If external_ids is specified, it will return the address with the matching external_ids or a superset of the external_ids
If name is specified, it will return the address with the matching name

If no address is found or multiple are found on that criteria, it will create a new one. If merge is true (defaults to false), it will merge the found address with the address argument. Merge will keep the not null values from the found address and overwrite the null values with the address passed in.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

required	object (addresses) An address, can be linked to a location.
patch	boolean <boolean>

Responses

Request samples

Payload

Content type

application/json

{"address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"patch": true
}

(rpc) upsert_shipments_full

/rpc/upsert_shipments_full

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipments_full

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipments_full)

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_number": "string",
"status": "unshipped",
"bill_of_lading": "string",
"order_number": "string",
"external_ids": null,
"additional_fields": null,
"carrier": "string",
"service": "string",
"scac": "string",
"tracking_number": "string",
"tracking_urls": ["string"
],
"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",
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"from_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"to_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"packages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
]
}
],
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
],
"internal_note": "string",
"external_note": "string"
}
}

(rpc) postgres_fdw_disconnect_all

/rpc/postgres_fdw_disconnect_all

Responses

/rpc/postgres_fdw_disconnect_all

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

(rpc) upsert_shipment_receipt

/rpc/upsert_shipment_receipt

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment_receipt

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_receipts) Record of receiving a shipment

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_receipt": {"id": "extensions.uuid_generate_v4()",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"received_time": "now()",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
}

(rpc) upsert_shipment_receipt_item

/rpc/upsert_shipment_receipt_item

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment_receipt_item

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_receipt_items) Record of items received in a shipment

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_receipt_item": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"quantity": 0,
"comment": "string",
"receipt_time": "now()",
"additional_fields": null,
"external_ids": null,
"available": true,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
}

(rpc) upsert_shipment_inventory_item

Upserts a shipment inventory item. If merge is true then it will merge the shipment inventory item with the existing shipment inventory item.

query Parameters

patch

boolean <boolean>

Responses

Upserts a shipment inventory item. If merge is true then it will merge the shipment inventory item with the existing shipment inventory item.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_inventory_items)

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_inventory_item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
}

(rpc) upsert_location_address

Upsert is short for insert or update.

Location_address is a view that joins locations and addresses together. The function uses the upsert_location and upsert_address functions to upsert the location and addresses. See the documentation for those functions for more information.

query Parameters

patch

boolean <boolean>

Responses

Upsert is short for insert or update.

Location_address is a view that joins locations and addresses together. The function uses the upsert_location and upsert_address functions to upsert the location and addresses. See the documentation for those functions for more information.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

required	object (location_addresses)
patch	boolean <boolean>

Responses

Request samples

Payload

Content type

application/json

{"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"patch": true
}

(rpc) magnify

/rpc/magnify

query Parameters

currency_code required	string <currency_code>
unmagnfiedamount required	number <numeric>

Responses

/rpc/magnify

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

currency_code required	string <currency_code>
unmagnfiedamount required	number <numeric>

Responses

Request samples

Payload

Content type

application/json

{"currency_code": "string",
"unmagnfiedamount": 0
}

(rpc) upsert_shipment_package_items

/rpc/upsert_shipment_package_items

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment_package_items

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_package_items)

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_package_item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"title": "string",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0
}
]
}
}

(rpc) upsert_shipment_receipts_full

/rpc/upsert_shipment_receipts_full

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment_receipts_full

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_receipts_full)

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_receipts_full": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_number": "string",
"status": "unshipped",
"bill_of_lading": "string",
"order_number": "string",
"external_ids": null,
"additional_fields": null,
"carrier": "string",
"service": "string",
"scac": "string",
"tracking_number": "string",
"tracking_urls": ["string"
],
"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",
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"from_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"to_location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"name": "string",
"fulfillment_sla_hours": 0,
"shipping_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
},
"billing_address": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"external_ids": null,
"name": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string",
"contact_name": "string",
"contact_phone": "string",
"contact_email": "string",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
},
"receipts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"received_time": "2019-08-24T14:15:22Z",
"completed_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"quantity": 0,
"title": "string",
"comment": "string",
"receipt_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"available": true
}
]
}
]
}
}

(rpc) postgres_fdw_disconnect

/rpc/postgres_fdw_disconnect

query Parameters

required

string <text>

Responses

/rpc/postgres_fdw_disconnect

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

required

string <text>

Responses

Request samples

Payload

Content type

application/json

{"": "string"
}

(rpc) postgres_fdw_handler

/rpc/postgres_fdw_handler

Responses

/rpc/postgres_fdw_handler

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

(rpc) upsert_shipment_receipt_inventory_items

/rpc/upsert_shipment_receipt_inventory_items

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment_receipt_inventory_items

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_receipt_inventory_items)

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_receipt_inventory_item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_receipt_id": "a2a36859-1c38-46a4-941d-993376e403b7",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"sku": "string",
"quantity": 0,
"title": "string",
"comment": "string",
"receipt_time": "2019-08-24T14:15:22Z",
"additional_fields": null,
"external_ids": null,
"available": true
}
}

(rpc) upsert_shipment_item

Upserts a shipment item. If merge is true then it will merge the shipment item with the existing shipment item.

query Parameters

patch

boolean <boolean>

Responses

Upserts a shipment item. If merge is true then it will merge the shipment item with the existing shipment item.

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch	boolean <boolean>
required	object (shipment_items) Shipment items are the items that are shipped, can be a child of either a shipment or a shipment carton. If the shipment item is a child of a shipment carton then it is must be a child of the shipment as well.

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment_item": {"id": "extensions.uuid_generate_v4()",
"business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
"shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
"shipment_package_id": "d8f3cd2f-88dd-454b-a245-d7e5013e256c",
"inventory_item_id": "18dd3e9a-1adb-4867-99a3-0bde9f26475c",
"additional_fields": null,
"external_ids": null,
"line_number": 0,
"quantity": 0,
"name": "string",
"upc": "string",
"lot_number": "string",
"hs_code": "string",
"hts_code": "string",
"country_of_origin": "string",
"serial_number": "string",
"currency_code": "string",
"unit_price": 0,
"discounted_price": 0,
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z"
}
}

(rpc) upsert_shipment

/rpc/upsert_shipment

query Parameters

patch

boolean <boolean>

Responses

/rpc/upsert_shipment

header Parameters

Prefer

string

Value: "params=single-object"

Preference

Request Body schema:
application/json
required

patch

boolean <boolean>

required

object (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.

Responses

Request samples

Payload

Content type

application/json

{"patch": true,
"shipment": {"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": ["string"
],
"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",
"creation_time": "now()",
"update_time": "2019-08-24T14:15:22Z",
"internal_note": "string",
"external_note": "string"
}
}

ChannelApe API

Introspection

OpenAPI description (this document)

Responses

order_line_items

A line item in an order

query Parameters

header Parameters

Responses

Response samples

A line item in an order

query Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.pgrst.object+json;nulls=strippedapplication/vnd.pgrst.object+jsontext/csvapplication/json

Responses

Request samples

A line item in an order

query Parameters

header Parameters

Responses

A line item in an order

query Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.pgrst.object+json;nulls=strippedapplication/vnd.pgrst.object+jsontext/csvapplication/json

Responses

Request samples

product_variant_options

The options that a product variant has

query Parameters

header Parameters

Responses

Response samples

The options that a product variant has

query Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.pgrst.object+json;nulls=strippedapplication/vnd.pgrst.object+jsontext/csvapplication/json

Responses

Request samples

The options that a product variant has

query Parameters

header Parameters

Responses

The options that a product variant has

query Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.pgrst.object+json;nulls=strippedapplication/vnd.pgrst.object+jsontext/csvapplication/json

Responses

Request samples

webhook_configurations

/webhook_configurations

query Parameters

header Parameters

Responses

Response samples

/webhook_configurations

query Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.pgrst.object+json;nulls=strippedapplication/vnd.pgrst.object+jsontext/csvapplication/json

Responses

Request samples

/webhook_configurations

query Parameters

header Parameters

Responses

/webhook_configurations

query Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.pgrst.object+json;nulls=strippedapplication/vnd.pgrst.object+jsontext/csvapplication/json

Responses

Request samples

channels

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

query Parameters

header Parameters

Responses

Response samples

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

query Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.pgrst.object+json;nulls=strippedapplication/vnd.pgrst.object+jsontext/csvapplication/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json