Create order

TypeScript

import { Configuration, OrdersApi } from "@zippendo/sdk"

const api = new OrdersApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.createOrder({ orgId: "...", createOrderRequest: { /* ... */ } })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.OrdersApi(client).create_order("...", zippendo.CreateOrderRequest())

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\OrdersApi(new GuzzleHttp\Client(), $config);
$result = $api->createOrder("...", new \Zippendo\Sdk\Model\CreateOrderRequest([]));

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.OrdersAPI.CreateOrder(ctx, "...").CreateOrderRequest(*zippendo.NewCreateOrderRequest()).Execute()

curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderNumber": "#1042",
  "orderChannelId": "clz9k2f0a0001abcd1234efgh",
  "orderLines": [
    {
      "name": "Wool Sweater",
      "quantity": 2,
      "sku": "SKU-1042-BLK",
      "unitPrice": 499,
      "totalPrice": 998,
      "currency": "DKK",
      "weight": 0.5,
      "weightUnit": "kg",
      "variantId": "44218900291",
      "productId": "8123456789",
      "imageUrl": "https://cdn.example.dk/products/sweater.jpg",
      "hsCode": "611020",
      "countryOfOrigin": "DK",
      "provinceOfOrigin": "DK-84",
      "barcode": "5712345678901",
      "requiresShipping": true,
      "taxable": true,
      "giftCard": false,
      "vendor": "Norse Knits",
      "id": "clz9k2f0a0004abcd3456qrst"
    }
  ],
  "externalId": "5012345678901",
  "customerName": "Anna Jensen",
  "customerEmail": "[email protected]",
  "shippingAddress": {
    "name": "Anna Jensen",
    "address1": "Nørregade 12",
    "city": "København",
    "postalCode": "1165",
    "countryCode": "DK",
    "attention": "c/o Reception",
    "company": "Jensen Design ApS",
    "address2": "2. sal",
    "province": "Hovedstaden",
    "provinceCode": "DK-84",
    "country": "Denmark",
    "phone": "+45 12 34 56 78",
    "email": "[email protected]"
  },
  "subtotalAmount": 998,
  "totalAmount": 1047,
  "currency": "DKK",
  "notes": "Leave at front desk",
  "shippingRuleId": "clz9k2f0a0007abcd2468qrst",
  "shippingMethodTitle": "GLS Hjemmelevering",
  "externalData": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    orderNumber: '#1042',
    orderChannelId: 'clz9k2f0a0001abcd1234efgh',
    orderLines: [
      {
        name: 'Wool Sweater',
        quantity: 2,
        sku: 'SKU-1042-BLK',
        unitPrice: 499,
        totalPrice: 998,
        currency: 'DKK',
        weight: 0.5,
        weightUnit: 'kg',
        variantId: '44218900291',
        productId: '8123456789',
        imageUrl: 'https://cdn.example.dk/products/sweater.jpg',
        hsCode: '611020',
        countryOfOrigin: 'DK',
        provinceOfOrigin: 'DK-84',
        barcode: '5712345678901',
        requiresShipping: true,
        taxable: true,
        giftCard: false,
        vendor: 'Norse Knits',
        id: 'clz9k2f0a0004abcd3456qrst'
      }
    ],
    externalId: '5012345678901',
    customerName: 'Anna Jensen',
    customerEmail: '[email protected]',
    shippingAddress: {
      name: 'Anna Jensen',
      address1: 'Nørregade 12',
      city: 'København',
      postalCode: '1165',
      countryCode: 'DK',
      attention: 'c/o Reception',
      company: 'Jensen Design ApS',
      address2: '2. sal',
      province: 'Hovedstaden',
      provinceCode: 'DK-84',
      country: 'Denmark',
      phone: '+45 12 34 56 78',
      email: '[email protected]'
    },
    subtotalAmount: 998,
    totalAmount: 1047,
    currency: 'DKK',
    notes: 'Leave at front desk',
    shippingRuleId: 'clz9k2f0a0007abcd2468qrst',
    shippingMethodTitle: 'GLS Hjemmelevering',
    externalData: {}
  })
};

fetch('https://api.zippendo.com/orgs/{orgId}/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/orders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderNumber\": \"#1042\",\n  \"orderChannelId\": \"clz9k2f0a0001abcd1234efgh\",\n  \"orderLines\": [\n    {\n      \"name\": \"Wool Sweater\",\n      \"quantity\": 2,\n      \"sku\": \"SKU-1042-BLK\",\n      \"unitPrice\": 499,\n      \"totalPrice\": 998,\n      \"currency\": \"DKK\",\n      \"weight\": 0.5,\n      \"weightUnit\": \"kg\",\n      \"variantId\": \"44218900291\",\n      \"productId\": \"8123456789\",\n      \"imageUrl\": \"https://cdn.example.dk/products/sweater.jpg\",\n      \"hsCode\": \"611020\",\n      \"countryOfOrigin\": \"DK\",\n      \"provinceOfOrigin\": \"DK-84\",\n      \"barcode\": \"5712345678901\",\n      \"requiresShipping\": true,\n      \"taxable\": true,\n      \"giftCard\": false,\n      \"vendor\": \"Norse Knits\",\n      \"id\": \"clz9k2f0a0004abcd3456qrst\"\n    }\n  ],\n  \"externalId\": \"5012345678901\",\n  \"customerName\": \"Anna Jensen\",\n  \"customerEmail\": \"[email protected]\",\n  \"shippingAddress\": {\n    \"name\": \"Anna Jensen\",\n    \"address1\": \"Nørregade 12\",\n    \"city\": \"København\",\n    \"postalCode\": \"1165\",\n    \"countryCode\": \"DK\",\n    \"attention\": \"c/o Reception\",\n    \"company\": \"Jensen Design ApS\",\n    \"address2\": \"2. sal\",\n    \"province\": \"Hovedstaden\",\n    \"provinceCode\": \"DK-84\",\n    \"country\": \"Denmark\",\n    \"phone\": \"+45 12 34 56 78\",\n    \"email\": \"[email protected]\"\n  },\n  \"subtotalAmount\": 998,\n  \"totalAmount\": 1047,\n  \"currency\": \"DKK\",\n  \"notes\": \"Leave at front desk\",\n  \"shippingRuleId\": \"clz9k2f0a0007abcd2468qrst\",\n  \"shippingMethodTitle\": \"GLS Hjemmelevering\",\n  \"externalData\": {}\n}")
  .asString();

{
  "id": "clz9k2f0a0003abcd9012mnop",
  "orderNumber": "#1042",
  "orderLines": [
    {
      "name": "Wool Sweater",
      "quantity": 2,
      "sku": "SKU-1042-BLK",
      "unitPrice": 499,
      "totalPrice": 998,
      "currency": "DKK",
      "weight": 0.5,
      "weightUnit": "kg",
      "variantId": "44218900291",
      "productId": "8123456789",
      "imageUrl": "https://cdn.example.dk/products/sweater.jpg",
      "hsCode": "611020",
      "countryOfOrigin": "DK",
      "provinceOfOrigin": "DK-84",
      "barcode": "5712345678901",
      "requiresShipping": true,
      "taxable": true,
      "giftCard": false,
      "vendor": "Norse Knits",
      "id": "clz9k2f0a0004abcd3456qrst"
    }
  ],
  "status": "processing",
  "orderChannelId": "clz9k2f0a0001abcd1234efgh",
  "orgId": "clz9k2f0a0000abcd0000zzzz",
  "createdAt": "2026-06-22T14:30:00.000Z",
  "updatedAt": "2026-06-22T14:30:00.000Z",
  "externalId": "5012345678901",
  "customerName": "Anna Jensen",
  "customerEmail": "[email protected]",
  "shippingAddress": {
    "name": "Anna Jensen",
    "address1": "Nørregade 12",
    "city": "København",
    "postalCode": "1165",
    "countryCode": "DK",
    "attention": "c/o Reception",
    "company": "Jensen Design ApS",
    "address2": "2. sal",
    "province": "Hovedstaden",
    "provinceCode": "DK-84",
    "country": "Denmark",
    "phone": "+45 12 34 56 78",
    "email": "[email protected]"
  },
  "subtotalAmount": 998,
  "totalAmount": 1047,
  "currency": "DKK",
  "shippingRuleId": "clz9k2f0a0002abcd5678ijkl",
  "notes": "Leave at front desk",
  "externalData": {}
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

POST

orgs

{orgId}

orders

TypeScript

import { Configuration, OrdersApi } from "@zippendo/sdk"

const api = new OrdersApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.createOrder({ orgId: "...", createOrderRequest: { /* ... */ } })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.OrdersApi(client).create_order("...", zippendo.CreateOrderRequest())

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\OrdersApi(new GuzzleHttp\Client(), $config);
$result = $api->createOrder("...", new \Zippendo\Sdk\Model\CreateOrderRequest([]));

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.OrdersAPI.CreateOrder(ctx, "...").CreateOrderRequest(*zippendo.NewCreateOrderRequest()).Execute()

curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderNumber": "#1042",
  "orderChannelId": "clz9k2f0a0001abcd1234efgh",
  "orderLines": [
    {
      "name": "Wool Sweater",
      "quantity": 2,
      "sku": "SKU-1042-BLK",
      "unitPrice": 499,
      "totalPrice": 998,
      "currency": "DKK",
      "weight": 0.5,
      "weightUnit": "kg",
      "variantId": "44218900291",
      "productId": "8123456789",
      "imageUrl": "https://cdn.example.dk/products/sweater.jpg",
      "hsCode": "611020",
      "countryOfOrigin": "DK",
      "provinceOfOrigin": "DK-84",
      "barcode": "5712345678901",
      "requiresShipping": true,
      "taxable": true,
      "giftCard": false,
      "vendor": "Norse Knits",
      "id": "clz9k2f0a0004abcd3456qrst"
    }
  ],
  "externalId": "5012345678901",
  "customerName": "Anna Jensen",
  "customerEmail": "[email protected]",
  "shippingAddress": {
    "name": "Anna Jensen",
    "address1": "Nørregade 12",
    "city": "København",
    "postalCode": "1165",
    "countryCode": "DK",
    "attention": "c/o Reception",
    "company": "Jensen Design ApS",
    "address2": "2. sal",
    "province": "Hovedstaden",
    "provinceCode": "DK-84",
    "country": "Denmark",
    "phone": "+45 12 34 56 78",
    "email": "[email protected]"
  },
  "subtotalAmount": 998,
  "totalAmount": 1047,
  "currency": "DKK",
  "notes": "Leave at front desk",
  "shippingRuleId": "clz9k2f0a0007abcd2468qrst",
  "shippingMethodTitle": "GLS Hjemmelevering",
  "externalData": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    orderNumber: '#1042',
    orderChannelId: 'clz9k2f0a0001abcd1234efgh',
    orderLines: [
      {
        name: 'Wool Sweater',
        quantity: 2,
        sku: 'SKU-1042-BLK',
        unitPrice: 499,
        totalPrice: 998,
        currency: 'DKK',
        weight: 0.5,
        weightUnit: 'kg',
        variantId: '44218900291',
        productId: '8123456789',
        imageUrl: 'https://cdn.example.dk/products/sweater.jpg',
        hsCode: '611020',
        countryOfOrigin: 'DK',
        provinceOfOrigin: 'DK-84',
        barcode: '5712345678901',
        requiresShipping: true,
        taxable: true,
        giftCard: false,
        vendor: 'Norse Knits',
        id: 'clz9k2f0a0004abcd3456qrst'
      }
    ],
    externalId: '5012345678901',
    customerName: 'Anna Jensen',
    customerEmail: '[email protected]',
    shippingAddress: {
      name: 'Anna Jensen',
      address1: 'Nørregade 12',
      city: 'København',
      postalCode: '1165',
      countryCode: 'DK',
      attention: 'c/o Reception',
      company: 'Jensen Design ApS',
      address2: '2. sal',
      province: 'Hovedstaden',
      provinceCode: 'DK-84',
      country: 'Denmark',
      phone: '+45 12 34 56 78',
      email: '[email protected]'
    },
    subtotalAmount: 998,
    totalAmount: 1047,
    currency: 'DKK',
    notes: 'Leave at front desk',
    shippingRuleId: 'clz9k2f0a0007abcd2468qrst',
    shippingMethodTitle: 'GLS Hjemmelevering',
    externalData: {}
  })
};

fetch('https://api.zippendo.com/orgs/{orgId}/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/orders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderNumber\": \"#1042\",\n  \"orderChannelId\": \"clz9k2f0a0001abcd1234efgh\",\n  \"orderLines\": [\n    {\n      \"name\": \"Wool Sweater\",\n      \"quantity\": 2,\n      \"sku\": \"SKU-1042-BLK\",\n      \"unitPrice\": 499,\n      \"totalPrice\": 998,\n      \"currency\": \"DKK\",\n      \"weight\": 0.5,\n      \"weightUnit\": \"kg\",\n      \"variantId\": \"44218900291\",\n      \"productId\": \"8123456789\",\n      \"imageUrl\": \"https://cdn.example.dk/products/sweater.jpg\",\n      \"hsCode\": \"611020\",\n      \"countryOfOrigin\": \"DK\",\n      \"provinceOfOrigin\": \"DK-84\",\n      \"barcode\": \"5712345678901\",\n      \"requiresShipping\": true,\n      \"taxable\": true,\n      \"giftCard\": false,\n      \"vendor\": \"Norse Knits\",\n      \"id\": \"clz9k2f0a0004abcd3456qrst\"\n    }\n  ],\n  \"externalId\": \"5012345678901\",\n  \"customerName\": \"Anna Jensen\",\n  \"customerEmail\": \"[email protected]\",\n  \"shippingAddress\": {\n    \"name\": \"Anna Jensen\",\n    \"address1\": \"Nørregade 12\",\n    \"city\": \"København\",\n    \"postalCode\": \"1165\",\n    \"countryCode\": \"DK\",\n    \"attention\": \"c/o Reception\",\n    \"company\": \"Jensen Design ApS\",\n    \"address2\": \"2. sal\",\n    \"province\": \"Hovedstaden\",\n    \"provinceCode\": \"DK-84\",\n    \"country\": \"Denmark\",\n    \"phone\": \"+45 12 34 56 78\",\n    \"email\": \"[email protected]\"\n  },\n  \"subtotalAmount\": 998,\n  \"totalAmount\": 1047,\n  \"currency\": \"DKK\",\n  \"notes\": \"Leave at front desk\",\n  \"shippingRuleId\": \"clz9k2f0a0007abcd2468qrst\",\n  \"shippingMethodTitle\": \"GLS Hjemmelevering\",\n  \"externalData\": {}\n}")
  .asString();

{
  "id": "clz9k2f0a0003abcd9012mnop",
  "orderNumber": "#1042",
  "orderLines": [
    {
      "name": "Wool Sweater",
      "quantity": 2,
      "sku": "SKU-1042-BLK",
      "unitPrice": 499,
      "totalPrice": 998,
      "currency": "DKK",
      "weight": 0.5,
      "weightUnit": "kg",
      "variantId": "44218900291",
      "productId": "8123456789",
      "imageUrl": "https://cdn.example.dk/products/sweater.jpg",
      "hsCode": "611020",
      "countryOfOrigin": "DK",
      "provinceOfOrigin": "DK-84",
      "barcode": "5712345678901",
      "requiresShipping": true,
      "taxable": true,
      "giftCard": false,
      "vendor": "Norse Knits",
      "id": "clz9k2f0a0004abcd3456qrst"
    }
  ],
  "status": "processing",
  "orderChannelId": "clz9k2f0a0001abcd1234efgh",
  "orgId": "clz9k2f0a0000abcd0000zzzz",
  "createdAt": "2026-06-22T14:30:00.000Z",
  "updatedAt": "2026-06-22T14:30:00.000Z",
  "externalId": "5012345678901",
  "customerName": "Anna Jensen",
  "customerEmail": "[email protected]",
  "shippingAddress": {
    "name": "Anna Jensen",
    "address1": "Nørregade 12",
    "city": "København",
    "postalCode": "1165",
    "countryCode": "DK",
    "attention": "c/o Reception",
    "company": "Jensen Design ApS",
    "address2": "2. sal",
    "province": "Hovedstaden",
    "provinceCode": "DK-84",
    "country": "Denmark",
    "phone": "+45 12 34 56 78",
    "email": "[email protected]"
  },
  "subtotalAmount": 998,
  "totalAmount": 1047,
  "currency": "DKK",
  "shippingRuleId": "clz9k2f0a0002abcd5678ijkl",
  "notes": "Leave at front desk",
  "externalData": {}
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

Authorizations

Authorization

string

header

required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId

string

required

Organization ID

Example:

"org_8f3kd92ld0"

Body

application/json

orderNumber

string

required

Human-readable order number.

Minimum string length: 1

Example:

"#1042"

orderChannelId

string

required

ID of the order channel this order belongs to.

Example:

"clz9k2f0a0001abcd1234efgh"

orderLines

object[]

required

Line items in the order.

Minimum array length: 1

Show child attributes

externalId

string | null

Identifier of the order in the source platform.

Example:

"5012345678901"

customerName

string | null

Customer full name.

Example:

"Anna Jensen"

customerEmail

string<email> | null

Customer email address.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"[email protected]"

shippingAddress

object | null

Destination shipping address.

Show child attributes

subtotalAmount

number | null

Order subtotal before shipping and tax.

Required range: x >= 0

Example:

998

totalAmount

number | null

Order grand total.

Required range: x >= 0

Example:

1047

currency

string | null

ISO 4217 currency code.

Required string length: 3

Example:

"DKK"

notes

string | null

Free-form internal notes.

Example:

"Leave at front desk"

shippingRuleId

string | null

Shipping rule to ship this order with. When set, a shipment is created immediately (and dispatched if the channel has autoShipOnCreate enabled).

Example:

"clz9k2f0a0007abcd2468qrst"

shippingMethodTitle

string | null

Shipping-method title from the source checkout; matched against the order channel's shipping-method mappings to pick a shipping rule.

Example:

"GLS Hjemmelevering"

externalData

object | null

Raw platform-specific payload for reference.

Show child attributes

Response

Default Response

string

required

Unique order ID.

Example:

"clz9k2f0a0003abcd9012mnop"

orderNumber

string

required

Human-readable order number.

Example:

"#1042"

orderLines

object[]

required

Line items in the order.

Show child attributes

status

enum<string>

required

Order fulfillment status derived from its shipments.

Available options:

pending,

processing,

partially_fulfilled,

fulfilled,

error,

cancelled

Example:

"processing"

orderChannelId

string

required

ID of the order channel this order belongs to.

Example:

"clz9k2f0a0001abcd1234efgh"

orgId

string

required

Owning organization ID.

Example:

"clz9k2f0a0000abcd0000zzzz"

createdAt

string

required

Creation timestamp (ISO 8601).

Example:

"2026-06-22T14:30:00.000Z"

updatedAt

string

required

Last update timestamp (ISO 8601).

Example:

"2026-06-22T14:30:00.000Z"

externalId

string | null

Identifier of the order in the source platform.

Example:

"5012345678901"

customerName

string | null

Customer full name.

Example:

"Anna Jensen"

customerEmail

string | null

Customer email address.

Example:

"[email protected]"

shippingAddress

object | null

Destination shipping address.

Show child attributes

subtotalAmount

number | null

Order subtotal before shipping and tax.

Example:

998

totalAmount

number | null

Order grand total.

Example:

1047

currency

string | null

ISO 4217 currency code.

Example:

"DKK"

shippingRuleId

string | null

ID of the applied shipping rule.

Example:

"clz9k2f0a0002abcd5678ijkl"

notes

string | null

Free-form internal notes.

Example:

"Leave at front desk"

externalData

object | null

Raw platform-specific payload for reference.

Show child attributes

Overview

SDKs

MCP server

System

Tokens

Orgs

Brands

Addresses

Carriers

Rules

Quotes

Shipments

Orders

Order Channels

Carrier Catalog

Billing

Webhooks

Authorizations

Path Parameters

Body

Response