Skip to main content
API docs by Redocly

ChannelApe API

Download OpenAPI specification:Download

Introspection

OpenAPI description (this document)

Responses

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

Content type
[
  • {
    }
]

enum_values

/enum_values

query Parameters
enum_type
string <name>
enum_value
string <name>
enum_order
string <real>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

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

Content type
[
  • {
    }
]

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

Content type
[
  • {
    }
]

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:

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

Content type
{
  • "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:

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

Content type
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",
  • "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

Content type
[
  • {
    }
]

/businesses

query Parameters
select
string

Filtering Columns

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

Preference

Request Body schema:

businesses

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

Note: This is a Primary Key.

name
required
string <text>
alphabetic_currency_code
string <text>

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

timezone_id
string <text>
inventory_item_key
string <text>
legacy_id
integer <integer>
creation_time
string <date-time>
Default: "now()"
update_time
string <date-time>

Responses

Request samples

Content type
{
  • "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:

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

Content type
{
  • "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"
}

shipment_webhooks

/shipment_webhooks

query Parameters
id
string <uuid>
business_id
string <uuid>
transaction_id
string <bigint>
shipment_id
string <uuid>
action
string <text>
status
string <public.webhook_status>
shipment_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

Content type
[
  • {
    }
]

/shipment_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:

shipment_webhooks

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

Note: This is a Primary Key.

business_id
required
string <uuid>
transaction_id
required
integer <bigint>
shipment_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_json
any <jsonb>
creation_time
string <date-time>
Default: "now()"
update_time
string <date-time>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "transaction_id": 0,
  • "shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
  • "action": "string",
  • "status": "ready",
  • "shipment_json": null,
  • "creation_time": "now()",
  • "update_time": "2019-08-24T14:15:22Z"
}

/shipment_webhooks

query Parameters
id
string <uuid>
business_id
string <uuid>
transaction_id
string <bigint>
shipment_id
string <uuid>
action
string <text>
status
string <public.webhook_status>
shipment_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_webhooks

query Parameters
id
string <uuid>
business_id
string <uuid>
transaction_id
string <bigint>
shipment_id
string <uuid>
action
string <text>
status
string <public.webhook_status>
shipment_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:

shipment_webhooks

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

Note: This is a Primary Key.

business_id
required
string <uuid>
transaction_id
required
integer <bigint>
shipment_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_json
any <jsonb>
creation_time
string <date-time>
Default: "now()"
update_time
string <date-time>

Responses

Request samples

Content type
{
  • "id": "extensions.uuid_generate_v4()",
  • "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  • "transaction_id": 0,
  • "shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
  • "action": "string",
  • "status": "ready",
  • "shipment_json": null,
  • "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

Content type
[
  • {
    }
]

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:

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

Content type
{
  • "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:

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

Content type
{
  • "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"
}

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

Content type
[
  • {
    }
]

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:

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

Content type
{
  • "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:

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

Content type
{
  • "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"
}

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

Content type
[
  • {
    }
]

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

Content type
[
  • {
    }
]

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

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

Content type
{
  • "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:

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

Content type
{
  • "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"
}

table_columns

/table_columns

query Parameters
table_name
string <text>
column_name
string <name>
is_primary_key
string <boolean>
data_type
string <text>
base_type
string <text>
type_category
string <text>
element_type_category
string <text>
max_characters
string <integer>
is_nullable
string <boolean>
has_default
string <boolean>
is_generated
string <boolean>
description
string <text>
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

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

Content type
[
  • {
    }
]

A line item in an order

query Parameters
select
string

Filtering Columns

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

Preference

Request Body schema:

order_line_items

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

Note: This is a Primary Key.

business_id
required
string <uuid>

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

order_id
required
string <uuid>

The order the line item belongs to.

inventory_item_id
string <uuid>

The inventory item the line item belongs to.

quantity
required
integer <integer>

The quantity of the line item.

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

The upc of the line item.

vendor
string <text>

The vendor of the line item.

grams
number <numeric>

The weight of the line item in grams.

price
integer <integer>

The price of the line item.

shipping_method
string <text>

The shipping method of the line item.

shipping_price
integer <integer>

The shipping price of the line item.

shipping_tax
integer <integer>

The shipping tax of the line item.

presale_quantity
integer <integer>

The presale quantity of the line item.

reserve_quantity
integer <integer>

The reserve quantity of the line item.

creation_time
string <date-time>
Default: "now()"
update_time
string <date-time>

Responses

Request samples

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

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

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

Content type
[
  • {
    }
]

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:

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

Content type
{
  • "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:

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

Content type
{
  • "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"
}

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

Content type
[
  • {
    }
]

/product_data

query Parameters
select
string

Filtering Columns

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

Preference

Request Body schema:

product_data

jwt
string <text>
name
string <public.short_text>
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

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

/product_data

query Parameters
jwt
string <text>
name
string <public.short_text>
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:

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

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

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

Content type
[
  • {
    }
]

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:

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

Content type
{
  • "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