Admin API (2023-02-10)
Download OpenAPI specification:Download
appsSettingsRetrieve
Retrieve a object of all app settings.
Authorizations:
path Parameters
clientId required | string |
header Parameters
X-29next-API-Version required | string Default: 2023-02-10 Value: "2023-02-10" |
Responses
Response samples
- 200
{- "property1": null,
- "property2": null
}
appsSettingsUpdate
Update an existing app settings.
Authorizations:
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
- Payload
{- "property1": null,
- "property2": null
}
Response samples
- 200
{- "property1": null,
- "property2": null
}
appsSettingsPartialUpdate
Partially update an existing app settings.
Authorizations:
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
- Payload
{- "property1": null,
- "property2": null
}
Response samples
- 200
{- "property1": null,
- "property2": null
}
assignedFulfillmentOrdersList
Retrieve assigned fulfillment order requests
Authorizations:
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
- 200
{- "count": 123,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
]
}
fulfillmentOrdersList
Retrieve a list of fulfillment orders.
Authorizations:
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
- 200
{- "count": 123,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
]
}
fulfillmentOrdersRetrieve
Retrieve a fulfillment order.
Authorizations:
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
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
cancellationRequestSend
Sends a fulfillment cancellation request to the fulfillment service.
Authorizations:
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
- Payload
{- "message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
cancellationRequestAccept
Accepts a fulfillment cancellation request sent to a fulfillment service for a fulfillment order.
Authorizations:
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
- Payload
{- "message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
cancellationRequestCancel
Cancel a requested fulfillment cancellation request.
Authorizations:
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
- Payload
{- "message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
cancellationRequestReject
Rejects a fulfillment cancellation request sent to a fulfillment service for a fulfillment order.
Authorizations:
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
- Payload
{- "message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
fulfillmentRequestSend
Sends a fulfillment request to the fulfillment service of a fulfillment order.
Authorizations:
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
- Payload
{- "message": "string",
- "fulfillment_order_line_items": [
- {
- "id": 0,
- "quantity": 1
}
], - "notify": true
}
Response samples
- 200
{- "original_fulfillment_order": {
- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}, - "requested_fulfillment_order": {
- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}, - "unrequested_fulfillment_order": {
- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
}
fulfillmentRequestAccept
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
Authorizations:
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
- Payload
{- "message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
fulfillmentRequestCancel
Cancel Requested Fulfillment Order.
Authorizations:
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
- Payload
{- "message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
fulfillmentRequestReject
Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
Authorizations:
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
- Payload
{- "rejected_reason": "incorrect_address",
- "message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
fulfillmentsRetrieve
Retrieve Fulfillments for a Fulfillment Order.
Authorizations:
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
- 200
{- "id": 0,
- "order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "shipping_method": "string",
- "status": "string",
- "location_id": 0,
- "line_items": [
- {
- "id": 0,
- "order_line_id": 0,
- "product_id": 0,
- "product_title": "string",
- "quantity": 2147483647,
- "fulfilled_quantity": "string",
- "returnable_quantity": "string",
- "returned_quantity": "string",
- "sku": "string",
- "fulfillment_service": "string",
- "requires_shipping": true,
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string"
}
], - "tracking_code": "string",
- "tracking_link": "string",
- "tracking_codes": null,
- "tracking_links": null
}
fulfillmentsCreate
Create Fulfillments for a Fulfillment Order.
Authorizations:
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
- Payload
{- "notify": true,
- "tracking_info": [
- {
- "tracking_code": "string",
- "carrier": "asendia",
- "carrier_other_name": "string"
}
], - "fulfillment_order_line_items": [
- {
- "id": 0,
- "quantity": 1
}
]
}
Response samples
- 201
{- "id": 0,
- "order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "shipping_method": "string",
- "status": "string",
- "location_id": 0,
- "line_items": [
- {
- "id": 0,
- "order_line_id": 0,
- "product_id": 0,
- "product_title": "string",
- "quantity": 2147483647,
- "fulfilled_quantity": "string",
- "returnable_quantity": "string",
- "returned_quantity": "string",
- "sku": "string",
- "fulfillment_service": "string",
- "requires_shipping": true,
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string"
}
], - "tracking_code": "string",
- "tracking_link": "string",
- "tracking_codes": null,
- "tracking_links": null
}
fulfillmentOrdersHold
Hold Fulfillment.
Authorizations:
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
- Payload
{- "reason": "address_incorrect",
- "reason_message": "string"
}
Response samples
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
fulfillmentOrdersReleaseHold
Release On Hold Fulfillment.
Authorizations:
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
- 200
{- "id": 0,
- "order_number": "string",
- "request_status": "pending",
- "status": "open",
- "supported_actions": [
- null
], - "shipping_address": {
- "id": 0,
- "country": "string",
- "title": "Mr",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "postcode": "string",
- "phone_number": "string",
- "notes": "string",
- "first_name": "string",
- "last_name": "string",
- "line4": "string",
- "state": "string"
}, - "line_items": [
- {
- "id": 0,
- "fulfillment_order_id": 0,
- "quantity": 2147483647,
- "order_line_id": 0,
- "stockrecord_id": 0,
- "sku": "string",
- "price_excl_tax": "string",
- "price_incl_tax": "string",
- "price_excl_tax_excl_discounts": "string",
- "price_incl_tax_excl_discounts": "string",
- "currency": "string",
- "product_id": "string",
- "product_title": "string",
}
], - "fulfillment_holds": [
- {
- "reason": "address_incorrect",
- "reason_message": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "name": "string",
- "code": "string"
}, - "assigned_location": {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}, - "merchant_requests": [
- {
- "type": "fulfill_request",
- "message": "string",
- "notify": true
}
]
}
locationsList
Retrieve a list of all configured fulfillment locations.
Authorizations:
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
- 200
{- "count": 123,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}
]
}
locationsCreate
Create a new fulfillment location.
Authorizations:
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
- Payload
{- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}
Response samples
- 201
{- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}
locationsRetrieve
Retrieve an existing fulfillment location.
Authorizations:
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
- 200
{- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}
locationsUpdate
Update an existing fulfillment location.
Authorizations:
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
- Payload
{- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}
Response samples
- 200
{- "id": 0,
- "address": {
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "line4": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "phone_number": "string"
}, - "name": "string",
- "accept_return": true
}
shippingMethodsList
Retrieve a list of all configured shipping methods.
Authorizations:
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
- 200
{- "count": 123,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "name": "string",
- "code": "string"
}
]
}
shippingMethodsRetrieve
Retrieve an existing shipping method.
Authorizations:
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
- 200
{- "name": "string",
- "code": "string"
}
cartsList
Retrieve a list of all open carts.
Authorizations:
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
- 200
{- "count": 123,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "status": "string",
- "lines": [
- {
- "id": 0,
- "product": {
- "id": 0,
- "title": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "upc": "string"
}, - "stockrecord": {
- "id": 0,
- "partner_sku": "string",
- "price_currency": "string",
- "price_retail": "string",
- "price": "string",
- "num_in_stock": -2147483648,
- "num_allocated": -2147483648,
- "low_stock_threshold": 2147483647
}, - "quantity": 2147483647,
- "price_currency": "string",
- "attributes": [
- {
- "option": "string",
- "value": "string"
}
], - "is_upsell": false
}
], - "abandoned": true,
- "currency": "string",
- "user": {
- "id": 0,
- "email": "user@example.com",
- "ip": "string",
- "first_name": "string",
- "last_name": "string",
- "phone_number": "string",
- "accepts_marketing": true,
- "language": "string",
- "user_agent": "string"
}, - "attribution": {
- "agent": {
- "id": 0,
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string"
}, - "funnel": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_campaign": "string",
- "utm_term": "string",
- "utm_content": "string",
- "gclid": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "affiliate": "string",
- "subaffiliate1": "string",
- "subaffiliate2": "string",
- "subaffiliate3": "string",
- "subaffiliate4": "string",
- "subaffiliate5": "string"
}, - "date_created": "2019-08-24T14:15:22Z",
- "metadata": {
- "property1": null,
- "property2": null
}
}
]
}
cartsCreate
Create a new cart.
Authorizations:
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
- Payload
{- "lines": [
- {
- "product_id": 0,
- "price": "string",
- "currency": "string",
- "quantity": 1,
- "subscription": {
- "price": "string",
- "interval": "day",
- "interval_count": 1
}, - "is_upsell": false
}
], - "user": {
- "id": 0,
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "ip": "string",
- "phone_number": "string",
- "language": "en",
- "tags": [
- "string"
], - "accepts_marketing": true,
- "metadata": {
- "property1": null,
- "property2": null
}, - "user_agent": "string"
}, - "send_welcome_email": false,
- "attribution": {
- "funnel": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_campaign": "string",
- "utm_term": "string",
- "utm_content": "string",
- "gclid": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "affiliate": "string",
- "subaffiliate1": "string",
- "subaffiliate2": "string",
- "subaffiliate3": "string",
- "subaffiliate4": "string",
- "subaffiliate5": "string",
- "agent": 0
}, - "vouchers": [
- "string"
], - "metadata": {
- "property1": null,
- "property2": null
}
}
Response samples
- 201
{- "id": 0,
- "status": "string",
- "lines": [
- {
- "id": 0,
- "product": {
- "id": 0,
- "title": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "upc": "string"
}, - "stockrecord": {
- "id": 0,
- "partner_sku": "string",
- "price_currency": "string",
- "price_retail": "string",
- "price": "string",
- "num_in_stock": -2147483648,
- "num_allocated": -2147483648,
- "low_stock_threshold": 2147483647
}, - "quantity": 2147483647,
- "price_currency": "string",
- "attributes": [
- {
- "option": "string",
- "value": "string"
}
], - "is_upsell": false
}
], - "abandoned": true,
- "total_incl_tax": "string",
- "total_excl_tax": "string",
- "currency": "string",
- "user": {
- "id": 0,
- "email": "user@example.com",
- "ip": "string",
- "first_name": "string",
- "last_name": "string",
- "phone_number": "string",
- "accepts_marketing": true,
- "language": "string",
- "user_agent": "string"
}, - "is_tax_known": true,
- "total_excl_tax_excl_discounts": "string",
- "total_incl_tax_excl_discounts": "string",
- "total_tax": "string",
- "voucher_discounts": [
- {
- "description": "string",
- "name": "string",
- "amount": "string",
- "voucher": {
- "name": "string",
- "code": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z"
}
}
], - "attribution": {
- "agent": {
- "id": 0,
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string"
}, - "funnel": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_campaign": "string",
- "utm_term": "string",
- "utm_content": "string",
- "gclid": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "affiliate": "string",
- "subaffiliate1": "string",
- "subaffiliate2": "string",
- "subaffiliate3": "string",
- "subaffiliate4": "string",
- "subaffiliate5": "string"
}, - "date_created": "2019-08-24T14:15:22Z",
- "metadata": {
- "property1": null,
- "property2": null
}
}
cartsRetrieve
Retrieve a cart.
Authorizations:
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
- 200
{- "id": 0,
- "status": "string",
- "lines": [
- {
- "id": 0,
- "product": {
- "id": 0,
- "title": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "upc": "string"
}, - "stockrecord": {
- "id": 0,
- "partner_sku": "string",
- "price_currency": "string",
- "price_retail": "string",
- "price": "string",
- "num_in_stock": -2147483648,
- "num_allocated": -2147483648,
- "low_stock_threshold": 2147483647
}, - "quantity": 2147483647,
- "price_currency": "string",
- "attributes": [
- {
- "option": "string",
- "value": "string"
}
], - "is_upsell": false
}
], - "abandoned": true,
- "total_incl_tax": "string",
- "total_excl_tax": "string",
- "currency": "string",
- "user": {
- "id": 0,
- "email": "user@example.com",
- "ip": "string",
- "first_name": "string",
- "last_name": "string",
- "phone_number": "string",
- "accepts_marketing": true,
- "language": "string",
- "user_agent": "string"
}, - "is_tax_known": true,
- "total_excl_tax_excl_discounts": "string",
- "total_incl_tax_excl_discounts": "string",
- "total_tax": "string",
- "voucher_discounts": [
- {
- "description": "string",
- "name": "string",
- "amount": "string",
- "voucher": {
- "name": "string",
- "code": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z"
}
}
], - "attribution": {
- "agent": {
- "id": 0,
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string"
}, - "funnel": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_campaign": "string",
- "utm_term": "string",
- "utm_content": "string",
- "gclid": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "affiliate": "string",
- "subaffiliate1": "string",
- "subaffiliate2": "string",
- "subaffiliate3": "string",
- "subaffiliate4": "string",
- "subaffiliate5": "string"
}, - "date_created": "2019-08-24T14:15:22Z",
- "metadata": {
- "property1": null,
- "property2": null
}
}
cartsUpdate
Update an existing cart.
Authorizations:
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
- Payload
{- "lines": [
- {
- "product_id": 0,
- "price": "string",
- "currency": "string",
- "quantity": 1,
- "subscription": {
- "price": "string",
- "interval": "day",
- "interval_count": 1
}, - "is_upsell": false
}
], - "attribution": {
- "funnel": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_campaign": "string",
- "utm_term": "string",
- "utm_content": "string",
- "gclid": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "affiliate": "string",
- "subaffiliate1": "string",
- "subaffiliate2": "string",
- "subaffiliate3": "string",
- "subaffiliate4": "string",
- "subaffiliate5": "string",
- "agent": 0
}, - "vouchers": [
- "string"
], - "metadata": {
- "property1": null,
- "property2": null
}
}
Response samples
- 200
{- "id": 0,
- "status": "string",
- "lines": [
- {
- "id": 0,
- "product": {
- "id": 0,
- "title": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "upc": "string"
}, - "stockrecord": {
- "id": 0,
- "partner_sku": "string",
- "price_currency": "string",
- "price_retail": "string",
- "price": "string",
- "num_in_stock": -2147483648,
- "num_allocated": -2147483648,
- "low_stock_threshold": 2147483647
}, - "quantity": 2147483647,
- "price_currency": "string",
- "attributes": [
- {
- "option": "string",
- "value": "string"
}
], - "is_upsell": false
}
], - "abandoned": true,
- "total_incl_tax": "string",
- "total_excl_tax": "string",
- "currency": "string",
- "user": {
- "id": 0,
- "email": "user@example.com",
- "ip": "string",
- "first_name": "string",
- "last_name": "string",
- "phone_number": "string",
- "accepts_marketing": true,
- "language": "string",
- "user_agent": "string"
}, - "is_tax_known": true,
- "total_excl_tax_excl_discounts": "string",
- "total_incl_tax_excl_discounts": "string",
- "total_tax": "string",
- "voucher_discounts": [
- {
- "description": "string",
- "name": "string",
- "amount": "string",
- "voucher": {
- "name": "string",
- "code": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z"
}
}
], - "attribution": {
- "agent": {
- "id": 0,
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string"
}, - "funnel": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_campaign": "string",
- "utm_term": "string",
- "utm_content": "string",
- "gclid": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "affiliate": "string",
- "subaffiliate1": "string",
- "subaffiliate2": "string",
- "subaffiliate3": "string",
- "subaffiliate4": "string",
- "subaffiliate5": "string"
}, - "date_created": "2019-08-24T14:15:22Z",
- "metadata": {
- "property1": null,
- "property2": null
}
}
categoriesList
Retrieve a list of categories.
Authorizations:
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
- 200
{- "count": 123,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "meta_title": "string",
- "meta_description": "string",
- "slug": "string",
- "is_public": true,
- "external_tax_code": "string",
- "template": "string"
}
]
}
categoriesCreate
Create a new category.
Authorizations:
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
- Payload
{- "name": "string",
- "description": "string",
- "meta_title": "string",
- "meta_description": "string",
- "slug": "string",
- "is_public": true,
- "external_tax_code": "string",
- "template": "string"
}
Response samples
- 201
{- "id": 0,
- "name": "string",
- "description": "string",
- "meta_title": "string",
- "meta_description": "string",
- "slug": "string",
- "is_public": true,
- "external_tax_code": "string",
- "template": "string"
}
categoriesRetrieve
Retrieve a category.
Authorizations:
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
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "meta_title": "string",
- "meta_description": "string",
- "slug": "string",
- "is_public": true,
- "external_tax_code": "string",
- "template": "string"
}
categoriesUpdate
Update an existing category.
Authorizations:
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
- Payload
{- "name": "string",
- "description": "string",
- "meta_title": "string",
- "meta_description": "string",
- "slug": "string",
- "is_public": true,
- "external_tax_code": "string",
- "template": "string"
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "meta_title": "string",
- "meta_description": "string",
- "slug": "string",
- "is_public": true,
- "external_tax_code": "string",
- "template": "string"
}
productsList
Retrieve a list of all products.
Authorizations:
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
- 200
{- "count": 123,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "title": "string",
- "slug": "string",
- "sku": "string",
- "track_stock": true,
- "allow_backorders": true,
- "structure": "standalone",
- "is_discountable": true,
- "is_public": true,
- "ranking": -2147483648,
- "categories": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "id": 0,
- "options": [
- "string"
], - "name": "string"
}, - "name": "string",
- "code": "string",
- "type": "option"
}
], - "children": [
- {
- "id": 0,
- "product_id": 0,
- "title": "string",
- "structure": "standalone",
- "sku": "string",
- "track_stock": true,
- "allow_backorders": true,
- "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "variant_attribute_values": [
- {
- "id": 0,
- "name": "string",
- "value": null,
- "code": "string"
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
]
}
], - "rating": 0,
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
]
}
productsCreate
Create a new product.
Authorizations:
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
- Payload
{- "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": [
- 0
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "location_id": 0,
- "num_in_stock": -2147483648,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "options": [
- "string"
], - "name": "string"
}, - "name": "string"
}
], - "template": "string",
- "meta_title": "string",
- "meta_description": "string"
}
Response samples
- 201
{- "id": 0,
- "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": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "id": 0,
- "options": [
- "string"
], - "name": "string"
}, - "name": "string",
- "code": "string",
- "type": "option"
}
], - "children": [
- {
- "id": 0,
- "product_id": 0,
- "title": "string",
- "structure": "standalone",
- "sku": "string",
- "track_stock": true,
- "allow_backorders": true,
- "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "variant_attribute_values": [
- {
- "id": 0,
- "name": "string",
- "value": null,
- "code": "string"
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
]
}
], - "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:
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
- 200
{- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
productsPricesCreate
Create a product price in an existing product.
Authorizations:
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
- Payload
{- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
Response samples
- 200
{- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
productsPricesRetrieve
Retrieve an price in an existing product.
Authorizations:
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
- 200
{- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
productsPricesPartialUpdate
Update an price in an existing product.
Authorizations:
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
- Payload
{- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
Response samples
- 200
{- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
productsRetrieve
Retrieve a product.
Authorizations:
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
- 200
{- "id": 0,
- "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": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "id": 0,
- "options": [
- "string"
], - "name": "string"
}, - "name": "string",
- "code": "string",
- "type": "option"
}
], - "children": [
- {
- "id": 0,
- "product_id": 0,
- "title": "string",
- "structure": "standalone",
- "sku": "string",
- "track_stock": true,
- "allow_backorders": true,
- "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "variant_attribute_values": [
- {
- "id": 0,
- "name": "string",
- "value": null,
- "code": "string"
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
]
}
], - "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:
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
- Payload
{- "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": [
- 0
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "options": [
- "string"
], - "name": "string"
}, - "name": "string"
}
], - "template": "string",
- "meta_title": "string",
- "meta_description": "string"
}
Response samples
- 200
{- "id": 0,
- "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": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "id": 0,
- "options": [
- "string"
], - "name": "string"
}, - "name": "string",
- "code": "string",
- "type": "option"
}
], - "children": [
- {
- "id": 0,
- "product_id": 0,
- "title": "string",
- "structure": "standalone",
- "sku": "string",
- "track_stock": true,
- "allow_backorders": true,
- "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "variant_attribute_values": [
- {
- "id": 0,
- "name": "string",
- "value": null,
- "code": "string"
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
]
}
], - "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:
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
- Payload
{- "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": [
- 0
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "options": [
- "string"
], - "name": "string"
}, - "name": "string"
}
], - "template": "string",
- "meta_title": "string",
- "meta_description": "string"
}
Response samples
- 200
{- "id": 0,
- "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": [
- {
- "id": 0,
- "name": "string",
- "slug": "string"
}
], - "enable_subscription": true,
- "interval": "day",
- "interval_counts": [
- -2147483648
], - "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
], - "requires_shipping": true,
- "recommended_products": [
- 0
], - "upc": "string",
- "external_tax_code": "string",
- "variant_attributes": [
- {
- "option_group": {
- "id": 0,
- "options": [
- "string"
], - "name": "string"
}, - "name": "string",
- "code": "string",
- "type": "option"
}
], - "children": [
- {
- "id": 0,
- "product_id": 0,
- "title": "string",
- "structure": "standalone",
- "sku": "string",
- "track_stock": true,
- "allow_backorders": true,
- "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "variant_attribute_values": [
- {
- "id": 0,
- "name": "string",
- "value": null,
- "code": "string"
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
]
}
], - "template": "string",
- "rating": 0,
- "meta_title": "string",
- "meta_description": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
productsChildrenList
Retrieve a list of child products for a product.
Authorizations:
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
- 200
{- "id": 0,
- "product_id": 0,
- "title": "string",
- "structure": "standalone",
- "sku": "string",
- "track_stock": true,
- "allow_backorders": true,
- "images": [
- {
- "id": 0,
- "caption": "string",
- "display_order": 2147483647,
- "product": 0
}
], - "variant_attribute_values": [
- {
- "id": 0,
- "name": "string",
- "value": null,
- "code": "string"
}
], - "prices": [
- {
- "currency": "string",
- "price": "string",
- "retail": "string",
- "subscription": "string",
- "subscription_suggested_downsell": "string"
}
], - "stockrecords": [
- {
- "id": 0,
- "location_id": 0,
- "sku": "string",
- "num_in_stock": -2147483648,
- "num_allocated": 0,
- "low_stock_threshold": 2147483647,
- "display_order": 2147483647
}
]
}
productsChildrenCreate
Create a child product in an existing product.
Authorizations:
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
- Payload
{- "sku": "string",
- "track_stock": true,
- <