Submit a new order.
POST
/api/v1/ordersSubmit an order for fulfillment. If everthing is good with the data provided, you will be provided an order number. Submitted orders does not reflect instantly in your account. It might take a couple of minutes because submitted orders are processed through a queue.
Request
Body Params application/json
No schema defined
Example
{
"externalId": "186898732",
"storeId": 818,
"shippingMethod": "default",
"productionTime": "regular",
"specialInstructions": "This is a special order.",
"printouts": [
"https://www.example.com/printout1.jpg",
"https://www.example.com/printout2.jpg",
"https://www.example.com/printout3.jpg"
],
"recipient": {
"firstName": "John",
"lastName": "Smith",
"addressLine1": "123 Main St.",
"addressLine2": "Apt. 123",
"city": "New York",
"state": "NY",
"zipCode": "10001",
"country": "US",
"phone": "123-456-7890",
"company": "ABC Company"
},
"orderItems": [
{
"externalItemId": "123456789",
"subcategoryId": 103001,
"quantity": 1,
"width": 8,
"height": 10,
"file": {
"imageUrl": "https://www.example.com/image.jpg"
},
"orderItemOptions": [
11,
51,
23
],
"solidColorHexCode": null
}
]
}
Request samples
Responses
Order has been successfully submitted.(201)
Bad Request(400)
Not Acceptable(406)
Order has been successfully submitted.
HTTP Code: 201
Content Type : JSONapplication/json
Data Schema
message
string
required
orderNumber
integer
required
Example
{
"message": "The preliminary checks for the order submission were successful. It has now been placed in the queue for processing.",
"orderNumber": 10000001440
}
Last modified: 2 months ago