Cart API

New Orders - Batch

This endpoint expects a json array containing a batch of orders. Each order should have the same fields as those listed in the New Order endpoint. Please see that endpoint for individual order field names.

Notes

Max order batch size: 100

Your warehouse may not pick up or use all of these fields. Any fields they do not use will be ignored.

Array Response Fields

The response element of the API response will contain two sub-elements, success and failed. Each of these elements will contain an array of results. Below is the list of all possible fields that may be set for each. See sample response for full details.

Field	Data Type	Description
cust_ref	String	cust_ref of provided order, if available
cust_po_no	String	cust_po_no of provided order, if available
index_pos	Int	In failed array only: 0-index Position of order in input array. Used if input order does not contain a valid order number.
message	String	In failed array only: Error message when loading order

post/v1/cart/orders/batch

Request

Base URL
http://{{base_url}}
Auth
HTTP basic
TypeScript
https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/docs/v1/cart/orders/batch/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Content-Typestring

Request body /

string required

Example request

"\"[\\n    {\\n        \\\"cust_ref\\\" : \\\"TEST02\\\",\\n        \\\"ship_company\\\" : \\\"Will Town\\\",\\n        \\\"ship_address_1\\\" : \\\"351 Hitchcock Way\\\",\\n        \\\"ship_address_2\\\" : \\\"Suite B140\\\",\\n        \\\"ship_city\\\" : \\\"Santa Barbara\\\",\\n        \\\"ship_state\\\" : \\\"CA\\\",\\n        \\\"ship_zip\\\" : \\\"93105\\\",\\n        \\\"ship_country\\\" : \\\"USA\\\",\\n        \\\"ship_is_billing\\\" : true,\\n        \\\"items\\\" : \\n        [\\n            {\\n                \\\"item\\\" : \\\"C100\\\",\\n                \\\"quantity\\\" : 2\\n            },\\n            {\\n                \\\"item\\\" : \\\"C300\\\",\\n                \\\"quantity\\\" : 1\\n            }\\n        ]\\n    },\\n    {\\n        \\\"cust_ref\\\" : \\\"TEST03\\\",\\n        \\\"ship_company\\\" : \\\"Will Town\\\",\\n        \\\"ship_address_1\\\" : \\\"351 Hitchcock Way\\\",\\n        \\\"ship_address_2\\\" : \\\"Suite B140\\\",\\n        \\\"ship_city\\\" : \\\"Santa Barbara\\\",\\n        \\\"ship_state\\\" : \\\"CA\\\",\\n        \\\"ship_zip\\\" : \\\"93105\\\",\\n        \\\"ship_country\\\" : \\\"USA\\\",\\n        \\\"ship_is_billing\\\" : true,\\n        \\\"items\\\" : \\n        [\\n            {\\n                \\\"item\\\" : \\\"C100\\\",\\n                \\\"quantity\\\" : 2\\n            },\\n            {\\n                \\\"item\\\" : \\\"C300\\\",\\n                \\\"quantity\\\" : 1\\n            }\\n        ]\\n    }\\n]\""

Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.