Create custom order

POST /orders/partner/{source}

Omnicado token based scheme

Path parameters

source string Required

Partner source identifier

application/json

Body Required

Partner custom order payload

id string Required
currency string Required
shippingCarrierCode string Required
parcelShopBranchCode string Required
shipmentDepartureTime string(date-time) Required
cashOnDelivery number | null
cashOnDeliveryPrice number(float)
deliveryPrice number(float)
phone string Required
email string Required
billingAddress object Required
Hide billingAddress attributes Show billingAddress attributes object
- regNo string
- vatNo string
- companyName string
- name string
- street string
- city string
- zip string
- countryCode string
deliveryAddress object Required
Hide deliveryAddress attributes Show deliveryAddress attributes object
- companyName string
- name string
- street string
- city string
- zip string
- countryCode string
items array[object] Required
Hide items attributes Show items attributes object
- orderItemId string
- code string
- title string
- quantity integer
- unitPrice number(float)
- vatRate number(float)

Responses

201 application/json

Partner order created
Hide response attributes Show response attributes object
- id integer(int64)
- remoteId string
- externalId string
- shipDate string(date-time)
- shippedDate string(date-time)
- deliveredDate string(date-time)
- currency string
  
  ISO currency code
- paymentType string
- paymentNo string
- expeditionStatus string
- orderStatus string
- source string
- totalPrice number(float)
- deliveryPrice number(float)
- discount number(float)
- cashOnDelivery number(float)
- cashOnDeliveryPrice number(float)
- cashOnDeliveryReceived boolean
- createdAt string(date-time)
- updatedAt string(date-time)
- deliveryProvider string
- externalBranchId string
- externalOrderProcessor string
- externalOrderProcessingId string
- externalOrderDeliveryCarrier string
- trackingNumber string
- trackingUrl string
- invoiceUrl string
- hasBcxCode boolean
- deliveryData array[object]
  
  Hide deliveryData attributes Show deliveryData attributes object
  
  id integer(int64)
  
  createdAt object
  
  Hide createdAt attributes Show createdAt attributes object
  
  date string
  
  timezone_type integer
  
  timezone string
  
  updatedAt object
  
  Hide updatedAt attributes Show updatedAt attributes object
  
  date string
  
  timezone_type integer
  
  timezone string
  
  company string
  
  name string
  
  phone string
  
  email string
  
  street string
  
  city string
  
  zip string
  
  country string
- items array[object]
  
  Hide items attributes Show items attributes object
  
  id integer(int64)
  
  createdAt object
  
  Hide createdAt attributes Show createdAt attributes object
  
  date string
  
  timezone_type integer
  
  timezone string
  
  updatedAt object
  
  Hide updatedAt attributes Show updatedAt attributes object
  
  date string
  
  timezone_type integer
  
  timezone string
  
  remoteId string
  
  quantity integer
  
  price number(float)
  
  priceWithoutVat number(float)
  
  priceWithoutCommissionWithoutVat number(float)
  
  vat number(integer)
  
  commission number(integer)
  
  serialNumberRequired boolean
  
  serialNumbers string

POST /orders/partner/{source}

curl \
 --request POST 'api.services.omnicado.com/api/v2/orders/partner/{source}' \
 --header "X-OMNICADO-TOKEN: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"id":"seller-order-id","currency":"CZK","shippingCarrierCode":"packeta","parcelShopBranchCode":"AB885","shipmentDepartureTime":"2025-07-05T14:30:00.000","cashOnDelivery":42.0,"cashOnDeliveryPrice":10.0,"deliveryPrice":50.0,"phone":"+420777666555","email":"mail@mail.com","billingAddress":{"regNo":"123","vatNo":"CZ123","companyName":"Abc","name":"John Doe","street":"Abc 123","city":"Praha","zip":"10000","countryCode":"CZ"},"deliveryAddress":{"companyName":"Abc","name":"John Doe","street":"Abc 123","city":"Praha","zip":"100000","countryCode":"CZ"},"items":[{"orderItemId":"id-on-seller-side","code":"product-sku","title":"Product name","quantity":2,"unitPrice":242.0,"vatRate":21.0}]}'

Request examples

{
  "id": "seller-order-id",
  "currency": "CZK",
  "shippingCarrierCode": "packeta",
  "parcelShopBranchCode": "AB885",
  "shipmentDepartureTime": "2025-07-05T14:30:00.000",
  "cashOnDelivery": 42.0,
  "cashOnDeliveryPrice": 10.0,
  "deliveryPrice": 50.0,
  "phone": "+420777666555",
  "email": "mail@mail.com",
  "billingAddress": {
    "regNo": "123",
    "vatNo": "CZ123",
    "companyName": "Abc",
    "name": "John Doe",
    "street": "Abc 123",
    "city": "Praha",
    "zip": "10000",
    "countryCode": "CZ"
  },
  "deliveryAddress": {
    "companyName": "Abc",
    "name": "John Doe",
    "street": "Abc 123",
    "city": "Praha",
    "zip": "100000",
    "countryCode": "CZ"
  },
  "items": [
    {
      "orderItemId": "id-on-seller-side",
      "code": "product-sku",
      "title": "Product name",
      "quantity": 2,
      "unitPrice": 242.0,
      "vatRate": 21.0
    }
  ]
}

Response examples (201)

{
  "id": 42,
  "remoteId": "string",
  "externalId": "string",
  "shipDate": "2025-05-04T09:42:00Z",
  "shippedDate": "2025-05-04T09:42:00Z",
  "deliveredDate": "2025-05-04T09:42:00Z",
  "currency": "CZK",
  "paymentType": "cashOnDelivery",
  "paymentNo": "202301010001",
  "expeditionStatus": "packing",
  "orderStatus": "shipping",
  "source": "string",
  "totalPrice": 1099.0,
  "deliveryPrice": 49.0,
  "discount": 0,
  "cashOnDelivery": 49.0,
  "cashOnDeliveryPrice": 12.0,
  "cashOnDeliveryReceived": false,
  "createdAt": "2025-05-04T09:42:00Z",
  "updatedAt": "2025-05-04T09:42:00Z",
  "deliveryProvider": "warehouse",
  "externalBranchId": "6471",
  "externalOrderProcessor": "shoptet",
  "externalOrderProcessingId": "CZ20230101",
  "externalOrderDeliveryCarrier": "ppl",
  "trackingNumber": "44592754091",
  "trackingUrl": "https://www.ppl.cz/vyhledat-zasilku?shipmentId=44592754091",
  "invoiceUrl": "string",
  "hasBcxCode": true,
  "deliveryData": [
    {
      "id": 42,
      "createdAt": {
        "date": "2023-01-24 13:30:03.000000",
        "timezone_type": 3,
        "timezone": "Europe/Prague"
      },
      "updatedAt": {
        "date": "2023-01-24 13:30:03.000000",
        "timezone_type": 3,
        "timezone": "Europe/Prague"
      },
      "company": "omnicado! s.r.o.",
      "name": "Jan Novák",
      "phone": "+420607049258",
      "email": "jan@novak.cz",
      "street": "Jaurisova 515/4",
      "city": "Praha",
      "zip": "50401",
      "country": "CZ"
    }
  ],
  "items": [
    {
      "id": 42,
      "createdAt": {
        "date": "2023-01-24 13:30:03.000000",
        "timezone_type": 3,
        "timezone": "Europe/Prague"
      },
      "updatedAt": {
        "date": "2023-01-24 13:30:03.000000",
        "timezone_type": 3,
        "timezone": "Europe/Prague"
      },
      "remoteId": "WH116",
      "quantity": 2,
      "price": 0.83,
      "priceWithoutVat": 0.69,
      "priceWithoutCommissionWithoutVat": 0.58,
      "vat": 21,
      "commission": 17,
      "serialNumberRequired": true,
      "serialNumbers": "00001;00002;00003"
    }
  ]
}