Skip to main content
API docs by Redocly

Admin API (2023-02-10)

Download OpenAPI specification:Download

apps

appsSettingsRetrieve

Retrieve a object of all app settings.

Authorizations:
tokenAuth
path Parameters
clientId
required
string
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

appsSettingsUpdate

Update an existing app settings.

Authorizations:
tokenAuth
path Parameters
clientId
required
string
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

appsSettingsPartialUpdate

Partially update an existing app settings.

Authorizations:
tokenAuth
path Parameters
clientId
required
string
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

appsSettingsDestroy

Delete an existing app settings.

Authorizations:
tokenAuth
path Parameters
clientId
required
string
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

fulfillment

assignedFulfillmentOrdersList

Retrieve assigned fulfillment order requests

Authorizations:
tokenAuth
query Parameters
location_id
string

Location ID

assignment_status
string
Enum: "cancellation_requested" "fulfillment_accepted" "fulfillment_requested" "fulfillment_unrequested"

Assignment Status

date_created_from
string <date>

YYYY-MM-DD

date_created_to
string <date>

YYYY-MM-DD

page
integer

A page number within the paginated result set.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

fulfillmentOrdersList

Retrieve a list of fulfillment orders.

Authorizations:
tokenAuth
query Parameters
order_number
string

Order Number

location_id
string

Location ID

status
Array of strings
Items Enum: "canceled" "closed" "incomplete" "on_hold" "open" "processing"

Status

request_status
Array of strings
Items Enum: "accepted" "cancel_accepted" "cancel_rejected" "cancel_requested" "pending" "rejected" "requested"

Request Status

fulfillment_order_id
string

Fulfillment Order Id

shipping_method
Array of strings

Shipping Method

date_created_from
string <date>

YYYY-MM-DD

date_created_to
string <date>

YYYY-MM-DD

page
integer

A page number within the paginated result set.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

fulfillmentOrdersRetrieve

Retrieve a fulfillment order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

cancellationRequestSend

Sends a fulfillment cancellation request to the fulfillment service.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
message
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

cancellationRequestAccept

Accepts a fulfillment cancellation request sent to a fulfillment service for a fulfillment order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
message
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

cancellationRequestCancel

Cancel a requested fulfillment cancellation request.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
message
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

cancellationRequestReject

Rejects a fulfillment cancellation request sent to a fulfillment service for a fulfillment order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
message
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

fulfillmentRequestSend

Sends a fulfillment request to the fulfillment service of a fulfillment order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
message
string or null <= 255 characters
Array of objects (FulfillmentOrderLineItem)
notify
boolean

Responses

Request samples

Content type
{
  • "message": "string",
  • "fulfillment_order_line_items": [
    ],
  • "notify": true
}

Response samples

Content type
application/json
{
  • "original_fulfillment_order": {
    },
  • "requested_fulfillment_order": {
    },
  • "unrequested_fulfillment_order": {
    }
}

fulfillmentRequestAccept

Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
message
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

fulfillmentRequestCancel

Cancel Requested Fulfillment Order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
message
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

fulfillmentRequestReject

Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
rejected_reason
string or null
Enum: "incorrect_address" "inventory_out_of_stock" "ineligible_product" "undeliverable_address" "other" "" null
message
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "rejected_reason": "incorrect_address",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

fulfillmentsRetrieve

Retrieve Fulfillments for a Fulfillment Order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "shipping_method": "string",
  • "status": "string",
  • "location_id": 0,
  • "line_items": [
    ],
  • "tracking_code": "string",
  • "tracking_link": "string",
  • "tracking_codes": null,
  • "tracking_links": null
}

fulfillmentsCreate

Create Fulfillments for a Fulfillment Order.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
notify
boolean
Default: true
Array of objects (TrackingInfo)
Array of objects (FulfillmentOrderLineItem)

Responses

Request samples

Content type
{
  • "notify": true,
  • "tracking_info": [
    ],
  • "fulfillment_order_line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "shipping_method": "string",
  • "status": "string",
  • "location_id": 0,
  • "line_items": [
    ],
  • "tracking_code": "string",
  • "tracking_link": "string",
  • "tracking_codes": null,
  • "tracking_links": null
}

fulfillmentOrdersHold

Hold Fulfillment.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
reason
string
Enum: "address_incorrect" "out_of_stock" "high_risk" "awaiting_payment" "other"
reason_message
string or null <= 512 characters

Responses

Request samples

Content type
{
  • "reason": "address_incorrect",
  • "reason_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

fulfillmentOrdersReleaseHold

Release On Hold Fulfillment.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this fulfillment order.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_number": "string",
  • "request_status": "pending",
  • "status": "open",
  • "supported_actions": [
    ],
  • "shipping_address": {
    },
  • "line_items": [
    ],
  • "fulfillment_holds": [
    ],
  • "shipping_method": {
    },
  • "assigned_location": {
    },
  • "merchant_requests": [
    ]
}

locationsList

Retrieve a list of all configured fulfillment locations.

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

locationsCreate

Create a new fulfillment location.

Authorizations:
tokenAuth
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
required
object (LocationAddress)
name
string <= 128 characters
callback_url
required
string <uri>
accept_return
boolean (Accepts Returns)

Responses

Request samples

Content type
{
  • "address": {
    },
  • "name": "string",
  • "callback_url": "http://example.com",
  • "accept_return": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "address": {
    },
  • "name": "string",
  • "callback_url": "http://example.com",
  • "accept_return": true
}

locationsRetrieve

Retrieve an existing fulfillment location.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Fulfillment partner.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "address": {
    },
  • "name": "string",
  • "callback_url": "http://example.com",
  • "accept_return": true
}

locationsUpdate

Update an existing fulfillment location.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Fulfillment partner.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
required
object (LocationAddress)
name
string <= 128 characters
callback_url
required
string <uri>
accept_return
boolean (Accepts Returns)

Responses

Request samples

Content type
{
  • "address": {
    },
  • "name": "string",
  • "callback_url": "http://example.com",
  • "accept_return": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "address": {
    },
  • "name": "string",
  • "callback_url": "http://example.com",
  • "accept_return": true
}

shippingMethodsList

Retrieve a list of all configured shipping methods.

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

shippingMethodsRetrieve

Retrieve an existing shipping method.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Order and Item Charge.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string"
}

carts

cartsList

Retrieve a list of all open carts.

Authorizations:
tokenAuth
query Parameters
product
Array of integers

Product

date_created_from
string <date>

YYYY-MM-DD

date_created_to
string <date>

YYYY-MM-DD

abandoned
boolean
currency
string

Currency

funnels
Array of strings or null (Funnel)

Funnels

utm_source
string

UTM Source

utm_campaign
string

UTM Campaign

utm_term
string

UTM Term

utm_content
string

UTM Content

affiliate
string

Affiliate

subaffiliate1
string

Sub Affiliate1

subaffiliate2
string

Sub Affiliate2

subaffiliate3
string

Sub Affiliate3

subaffiliate4
string

Sub Affiliate4

subaffiliate5
string

Sub Affiliate5

page
integer

A page number within the paginated result set.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

cartsCreate

Create a new cart.

Authorizations:
tokenAuth
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
required
Array of objects (CreateOrderLine)
object (CreateCartUser)
send_welcome_email
boolean
Default: false
object (CreateMarketingAttribution)
vouchers
Array of strings or null
object or null

Responses

Request samples

Content type
{
  • "lines": [
    ],
  • "user": {
    },
  • "send_welcome_email": false,
  • "attribution": {
    },
  • "vouchers": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "lines": [
    ],
  • "abandoned": true,
  • "total_incl_tax": "string",
  • "total_excl_tax": "string",
  • "currency": "string",
  • "user": {
    },
  • "is_tax_known": true,
  • "total_excl_tax_excl_discounts": "string",
  • "total_incl_tax_excl_discounts": "string",
  • "total_tax": "string",
  • "voucher_discounts": [
    ],
  • "attribution": {
    },
  • "checkout_url": "http://example.com",
  • "date_created": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

cartsRetrieve

Retrieve a cart.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Cart.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "lines": [
    ],
  • "abandoned": true,
  • "total_incl_tax": "string",
  • "total_excl_tax": "string",
  • "currency": "string",
  • "user": {
    },
  • "is_tax_known": true,
  • "total_excl_tax_excl_discounts": "string",
  • "total_incl_tax_excl_discounts": "string",
  • "total_tax": "string",
  • "voucher_discounts": [
    ],
  • "attribution": {
    },
  • "checkout_url": "http://example.com",
  • "date_created": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

cartsUpdate

Update an existing cart.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Cart.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
required
Array of objects (CreateOrderLine)
object (CreateMarketingAttribution)
vouchers
Array of strings or null
object or null

Responses

Request samples

Content type
{
  • "lines": [
    ],
  • "attribution": {
    },
  • "vouchers": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "lines": [
    ],
  • "abandoned": true,
  • "total_incl_tax": "string",
  • "total_excl_tax": "string",
  • "currency": "string",
  • "user": {
    },
  • "is_tax_known": true,
  • "total_excl_tax_excl_discounts": "string",
  • "total_incl_tax_excl_discounts": "string",
  • "total_tax": "string",
  • "voucher_discounts": [
    ],
  • "attribution": {
    },
  • "checkout_url": "http://example.com",
  • "date_created": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

cartsDestroy

Delete an existing cart.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Cart.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

products

categoriesList

Retrieve a list of categories.

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

categoriesCreate

Create a new category.

Authorizations:
tokenAuth
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
name
required
string <= 255 characters
description
string
meta_title
string or null <= 255 characters
meta_description
string or null
image
string or null <uri>
slug
required
string <= 255 characters ^[-a-zA-Z0-9_]+$
is_public
boolean

Show this category in search results and catalogue listings.

external_tax_code
string or null (Tax Code) <= 64 characters

Tax code to be used with external tax systems such as Avalara, Taxjar.

template
string or null (Theme Template) <= 256 characters

Use a custom template from your theme to customize the category display.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "meta_title": "string",
  • "meta_description": "string",
  • "image": "http://example.com",
  • "slug": "string",
  • "is_public": true,
  • "external_tax_code": "string",
  • "template": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "meta_title": "string",
  • "meta_description": "string",
  • "image": "http://example.com",
  • "slug": "string",
  • "is_public": true,
  • "external_tax_code": "string",
  • "template": "string"
}

categoriesRetrieve

Retrieve a category.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Category.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "meta_title": "string",
  • "meta_description": "string",
  • "image": "http://example.com",
  • "slug": "string",
  • "is_public": true,
  • "external_tax_code": "string",
  • "template": "string"
}

categoriesUpdate

Update an existing category.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Category.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
name
required
string <= 255 characters
description
string
meta_title
string or null <= 255 characters
meta_description
string or null
image
string or null <uri>
slug
required
string <= 255 characters ^[-a-zA-Z0-9_]+$
is_public
boolean

Show this category in search results and catalogue listings.

external_tax_code
string or null (Tax Code) <= 64 characters

Tax code to be used with external tax systems such as Avalara, Taxjar.

template
string or null (Theme Template) <= 256 characters

Use a custom template from your theme to customize the category display.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "meta_title": "string",
  • "meta_description": "string",
  • "image": "http://example.com",
  • "slug": "string",
  • "is_public": true,
  • "external_tax_code": "string",
  • "template": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "meta_title": "string",
  • "meta_description": "string",
  • "image": "http://example.com",
  • "slug": "string",
  • "is_public": true,
  • "external_tax_code": "string",
  • "template": "string"
}

productsList

Retrieve a list of all products.

Authorizations:
tokenAuth
query Parameters
title
string
category
Array of integers

Categories

range
Array of integers

Range

is_public
boolean

Is Public

sku
string
page
integer

A page number within the paginated result set.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

productsCreate

Create a new product.

Authorizations:
tokenAuth
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
title
required
string
slug
string <= 255 characters ^[-a-zA-Z0-9_]+$
description
string
sku
string
track_stock
boolean (Track Stock Levels)

Track inventory quantities at fulfillment locations.

allow_backorders
boolean

Continue selling when out of stock.

structure
string (Product Structure)
Enum: "standalone" "parent" "child"
is_discountable
boolean (Is discountable?)

This flag indicates if this product can be used in an offer or not

is_public
boolean

Show this product in search results and catalogue listings.

ranking
integer [ -2147483648 .. 2147483647 ]

The highest ranking are shown first

categories
Array of integers
enable_subscription
boolean
interval
string or null (Subscription Interval)
Enum: "day" "week" "month" "year" "" null
interval_counts
Array of integers or null or null (Interval Count Options)

Choose a predefined value or type to enter custom value(s).

Array of objects (ProductPrices)
Array of objects (Stockrecord )
requires_shipping
boolean (Requires shipping?)
recommended_products
Array of integers
upc
string or null <= 64 characters

Universal Product Code (UPC) is an identifier for a product which is not specific to a particular supplier. Eg an ISBN for a book.

external_tax_code
string or null (Tax Code) <= 64 characters

Tax code to be used with external tax systems such as Avalara, TaxJar.

Array of objects (ProductVariantAttribute)
template
string or null (Theme Template) <= 256 characters

Use a custom template from your theme to customize the product display.

meta_title
string or null <= 255 characters
meta_description
string or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "slug": "string",
  • "description": "string",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "structure": "standalone",
  • "is_discountable": true,
  • "is_public": true,
  • "ranking": -2147483648,
  • "categories": [
    ],
  • "enable_subscription": true,
  • "interval": "day",
  • "interval_counts": [
    ],
  • "prices": [
    ],
  • "stockrecords": [
    ],
  • "requires_shipping": true,
  • "recommended_products": [
    ],
  • "upc": "string",
  • "external_tax_code": "string",
  • "variant_attributes": [
    ],
  • "template": "string",
  • "meta_title": "string",
  • "meta_description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "http://example.com",
  • "title": "string",
  • "slug": "string",
  • "description": "string",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "structure": "standalone",
  • "is_discountable": true,
  • "is_public": true,
  • "ranking": -2147483648,
  • "categories": [
    ],
  • "enable_subscription": true,
  • "interval": "day",
  • "interval_counts": [
    ],
  • "images": [
    ],
  • "prices": [
    ],
  • "stockrecords": [
    ],
  • "requires_shipping": true,
  • "recommended_products": [
    ],
  • "upc": "string",
  • "external_tax_code": "string",
  • "variant_attributes": [
    ],
  • "children": [
    ],
  • "template": "string",
  • "rating": 0,
  • "meta_title": "string",
  • "meta_description": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

productsPricesList

Retrieve a list of price products for a product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "currency": "string",
  • "price": "string",
  • "retail": "string",
  • "subscription": "string",
  • "subscription_suggested_downsell": "string"
}

productsPricesCreate

Create a product price in an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
currency
string <= 12 characters
price
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,2})?$
retail
string or null <decimal> (Price (retail)) ^-?\d{0,10}(?:\.\d{0,2})?$
subscription
string or null <decimal> (Subscription Price) ^-?\d{0,10}(?:\.\d{0,2})?$
subscription_suggested_downsell
string or null <decimal> (Suggested Downsell Price) ^-?\d{0,10}(?:\.\d{0,2})?$

Responses

Request samples

Content type
{
  • "currency": "string",
  • "price": "string",
  • "retail": "string",
  • "subscription": "string",
  • "subscription_suggested_downsell": "string"
}

Response samples

Content type
application/json
{
  • "currency": "string",
  • "price": "string",
  • "retail": "string",
  • "subscription": "string",
  • "subscription_suggested_downsell": "string"
}

productsPricesRetrieve

Retrieve an price in an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Price.

currency
required
string
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "price": "string",
  • "retail": "string",
  • "subscription": "string",
  • "subscription_suggested_downsell": "string"
}

productsPricesPartialUpdate

Update an price in an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Price.

currency
required
string
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
price
string <decimal> ^-?\d{0,10}(?:\.\d{0,2})?$
retail
string or null <decimal> (Price (retail)) ^-?\d{0,10}(?:\.\d{0,2})?$
subscription
string or null <decimal> (Subscription Price) ^-?\d{0,10}(?:\.\d{0,2})?$
subscription_suggested_downsell
string or null <decimal> (Suggested Downsell Price) ^-?\d{0,10}(?:\.\d{0,2})?$

Responses

Request samples

Content type
{
  • "price": "string",
  • "retail": "string",
  • "subscription": "string",
  • "subscription_suggested_downsell": "string"
}

Response samples

Content type
application/json
{
  • "price": "string",
  • "retail": "string",
  • "subscription": "string",
  • "subscription_suggested_downsell": "string"
}

productsPricesDestroy

Delete an price in an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Price.

currency
required
string
header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

productsRetrieve

Retrieve a product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "http://example.com",
  • "title": "string",
  • "slug": "string",
  • "description": "string",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "structure": "standalone",
  • "is_discountable": true,
  • "is_public": true,
  • "ranking": -2147483648,
  • "categories": [
    ],
  • "enable_subscription": true,
  • "interval": "day",
  • "interval_counts": [
    ],
  • "images": [
    ],
  • "prices": [
    ],
  • "stockrecords": [
    ],
  • "requires_shipping": true,
  • "recommended_products": [
    ],
  • "upc": "string",
  • "external_tax_code": "string",
  • "variant_attributes": [
    ],
  • "children": [
    ],
  • "template": "string",
  • "rating": 0,
  • "meta_title": "string",
  • "meta_description": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

productsUpdate

Update an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
title
string
slug
string <= 255 characters ^[-a-zA-Z0-9_]+$
description
string
sku
string
track_stock
boolean (Track Stock Levels)

Track inventory quantities at fulfillment locations.

allow_backorders
boolean

Continue selling when out of stock.

structure
string (Product Structure)
Enum: "standalone" "parent" "child"
is_discountable
boolean (Is discountable?)

This flag indicates if this product can be used in an offer or not

is_public
boolean

Show this product in search results and catalogue listings.

ranking
integer [ -2147483648 .. 2147483647 ]

The highest ranking are shown first

categories
Array of integers
enable_subscription
boolean
interval
string or null (Subscription Interval)
Enum: "day" "week" "month" "year" "" null
interval_counts
Array of integers or null or null (Interval Count Options)

Choose a predefined value or type to enter custom value(s).

Array of objects (ProductPrices)
requires_shipping
boolean (Requires shipping?)
recommended_products
Array of integers
upc
string or null <= 64 characters

Universal Product Code (UPC) is an identifier for a product which is not specific to a particular supplier. Eg an ISBN for a book.

external_tax_code
string or null (Tax Code) <= 64 characters

Tax code to be used with external tax systems such as Avalara, TaxJar.

Array of objects (ProductVariantAttribute)
template
string or null (Theme Template) <= 256 characters

Use a custom template from your theme to customize the product display.

meta_title
string or null <= 255 characters
meta_description
string or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "slug": "string",
  • "description": "string",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "structure": "standalone",
  • "is_discountable": true,
  • "is_public": true,
  • "ranking": -2147483648,
  • "categories": [
    ],
  • "enable_subscription": true,
  • "interval": "day",
  • "interval_counts": [
    ],
  • "prices": [
    ],
  • "requires_shipping": true,
  • "recommended_products": [
    ],
  • "upc": "string",
  • "external_tax_code": "string",
  • "variant_attributes": [
    ],
  • "template": "string",
  • "meta_title": "string",
  • "meta_description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "http://example.com",
  • "title": "string",
  • "slug": "string",
  • "description": "string",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "structure": "standalone",
  • "is_discountable": true,
  • "is_public": true,
  • "ranking": -2147483648,
  • "categories": [
    ],
  • "enable_subscription": true,
  • "interval": "day",
  • "interval_counts": [
    ],
  • "images": [
    ],
  • "prices": [
    ],
  • "stockrecords": [
    ],
  • "requires_shipping": true,
  • "recommended_products": [
    ],
  • "upc": "string",
  • "external_tax_code": "string",
  • "variant_attributes": [
    ],
  • "children": [
    ],
  • "template": "string",
  • "rating": 0,
  • "meta_title": "string",
  • "meta_description": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

productsPartialUpdate

Partially update an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
title
string
slug
string <= 255 characters ^[-a-zA-Z0-9_]+$
description
string
sku
string
track_stock
boolean (Track Stock Levels)

Track inventory quantities at fulfillment locations.

allow_backorders
boolean

Continue selling when out of stock.

structure
string (Product Structure)
Enum: "standalone" "parent" "child"
is_discountable
boolean (Is discountable?)

This flag indicates if this product can be used in an offer or not

is_public
boolean

Show this product in search results and catalogue listings.

ranking
integer [ -2147483648 .. 2147483647 ]

The highest ranking are shown first

categories
Array of integers
enable_subscription
boolean
interval
string or null (Subscription Interval)
Enum: "day" "week" "month" "year" "" null
interval_counts
Array of integers or null or null (Interval Count Options)

Choose a predefined value or type to enter custom value(s).

Array of objects (ProductPrices)
requires_shipping
boolean (Requires shipping?)
recommended_products
Array of integers
upc
string or null <= 64 characters

Universal Product Code (UPC) is an identifier for a product which is not specific to a particular supplier. Eg an ISBN for a book.

external_tax_code
string or null (Tax Code) <= 64 characters

Tax code to be used with external tax systems such as Avalara, TaxJar.

Array of objects (ProductVariantAttribute)
template
string or null (Theme Template) <= 256 characters

Use a custom template from your theme to customize the product display.

meta_title
string or null <= 255 characters
meta_description
string or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "slug": "string",
  • "description": "string",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "structure": "standalone",
  • "is_discountable": true,
  • "is_public": true,
  • "ranking": -2147483648,
  • "categories": [
    ],
  • "enable_subscription": true,
  • "interval": "day",
  • "interval_counts": [
    ],
  • "prices": [
    ],
  • "requires_shipping": true,
  • "recommended_products": [
    ],
  • "upc": "string",
  • "external_tax_code": "string",
  • "variant_attributes": [
    ],
  • "template": "string",
  • "meta_title": "string",
  • "meta_description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "http://example.com",
  • "title": "string",
  • "slug": "string",
  • "description": "string",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "structure": "standalone",
  • "is_discountable": true,
  • "is_public": true,
  • "ranking": -2147483648,
  • "categories": [
    ],
  • "enable_subscription": true,
  • "interval": "day",
  • "interval_counts": [
    ],
  • "images": [
    ],
  • "prices": [
    ],
  • "stockrecords": [
    ],
  • "requires_shipping": true,
  • "recommended_products": [
    ],
  • "upc": "string",
  • "external_tax_code": "string",
  • "variant_attributes": [
    ],
  • "children": [
    ],
  • "template": "string",
  • "rating": 0,
  • "meta_title": "string",
  • "meta_description": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

productsDestroy

Delete an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

productsChildrenList

Retrieve a list of child products for a product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "title": "string",
  • "structure": "standalone",
  • "sku": "string",
  • "track_stock": true,
  • "allow_backorders": true,
  • "images": [
    ],
  • "variant_attribute_values": [
    ],
  • "prices": [
    ],
  • "stockrecords": [
    ]
}

productsChildrenCreate

Create a child product in an existing product.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Product.

header Parameters
X-29next-API-Version
required
string
Default: 2023-02-10
Value: "2023-02-10"
Request Body schema:
sku
required
string or null <= 128 characters

Stock Keeping Unit.

track_stock
boolean (Track Stock Levels)

Track inventory quantities at fulfillment locations.

allow_backorders
boolean

Continue selling when out of stock.

image
integer or null
required
Array of objects (ProductVariantAttributeValue)
Array of objects (Stockrecord )
Array of objects (ProductPrices)

Responses

Request samples

Content type
{
  • "sku": "string",
  • "track_stock": true,
  • <