Orders
Place Order
Place a new order
POST
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
orders
Pass in the user’s details for personalized items. See personalization guide for more details
Tax number
For Brazil, China, Italy, and South Korea you must pass in an additional taxNumber field. For Brazil the tax number field must pass regex validation as follows
new RegExp(`^\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}$`).test(taxNumber)
For China, Italy, and South Korea there is no validation run on the taxNumber field.
Personalization
To order a product with personalization the personalized product must first be created via the getProduct or listProducts endpoints
CustomAttributes
Custom attribute field is deprecated. Please use the taxNumber field instead
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
collectionId
string
requiredBody
application/json
companyId
string
isVip
boolean
user
object
requiredorderItems
object[]
requiredtaxNumber
string
customAttributes
object[]
address
object
requirednote
string
personalizations
object
externalId
string
shouldSendEmail
boolean
default: trueshouldValidateProvinceCode
boolean
Response
200 - application/json
order
object
required