Skip to main content
POST
/
orgs
/
{orgId}
/
orders
Creates a new order
curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderNumber": "<string>",
  "orderChannelId": "<string>",
  "orderLines": [
    {
      "name": "<string>",
      "quantity": 123,
      "sku": "<string>",
      "unitPrice": 1,
      "totalPrice": 1,
      "currency": "<string>",
      "weight": 1,
      "weightUnit": "kg",
      "variantId": "<string>",
      "productId": "<string>",
      "imageUrl": "<string>",
      "hsCode": "<string>",
      "countryOfOrigin": "<string>",
      "provinceOfOrigin": "<string>",
      "barcode": "<string>",
      "requiresShipping": true,
      "taxable": true,
      "giftCard": true,
      "vendor": "<string>"
    }
  ],
  "externalId": "<string>",
  "customerName": "<string>",
  "customerEmail": "jsmith@example.com",
  "shippingAddress": {
    "name": "<string>",
    "address1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>",
    "attention": "<string>",
    "company": "<string>",
    "address2": "<string>",
    "province": "<string>",
    "provinceCode": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "email": "jsmith@example.com"
  },
  "totalAmount": 1,
  "currency": "<string>",
  "notes": "<string>",
  "externalData": {}
}
'
{
  "id": "<string>",
  "orderNumber": "<string>",
  "orderLines": [
    {
      "name": "<string>",
      "quantity": 123,
      "sku": "<string>",
      "unitPrice": 1,
      "totalPrice": 1,
      "currency": "<string>",
      "weight": 1,
      "weightUnit": "kg",
      "variantId": "<string>",
      "productId": "<string>",
      "imageUrl": "<string>",
      "hsCode": "<string>",
      "countryOfOrigin": "<string>",
      "provinceOfOrigin": "<string>",
      "barcode": "<string>",
      "requiresShipping": true,
      "taxable": true,
      "giftCard": true,
      "vendor": "<string>"
    }
  ],
  "status": "pending",
  "orderChannelId": "<string>",
  "orgId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "externalId": "<string>",
  "customerName": "<string>",
  "customerEmail": "<string>",
  "shippingAddress": {
    "name": "<string>",
    "address1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>",
    "attention": "<string>",
    "company": "<string>",
    "address2": "<string>",
    "province": "<string>",
    "provinceCode": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "email": "jsmith@example.com"
  },
  "totalAmount": 123,
  "currency": "<string>",
  "shippingRuleId": "<string>",
  "notes": "<string>",
  "externalData": {}
}

Authorizations

​
Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

​
orgId
string
required

Organization ID

Body

application/json
​
orderNumber
string
required
Minimum string length: 1
​
orderChannelId
string
required
​
orderLines
object[]
required
Minimum array length: 1
​
externalId
string | null
​
customerName
string | null
​
customerEmail
string<email> | null
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
shippingAddress
object
​
totalAmount
number | null
Required range: x >= 0
​
currency
string | null
Required string length: 3
​
notes
string | null
​
externalData
object

Response

Default Response

​
id
string
required
​
orderNumber
string
required
​
orderLines
object[]
required
​
status
enum<string>
required
Available options:
pending,
processing,
partially_fulfilled,
fulfilled,
error,
cancelled
​
orderChannelId
string
required
​
orgId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
externalId
string | null
​
customerName
string | null
​
customerEmail
string | null
​
shippingAddress
object
​
totalAmount
number | null
​
currency
string | null
​
shippingRuleId
string | null
​
notes
string | null
​
externalData
object