Create testing order

POST /testing-order

Omnicado token based scheme

This endpoint is used to create order for testing purposes

application/json

Body Required

sellingChannelId integer
currency string

Default value is CZK.
status string

Default value is open.
useMarketplaceCarrier boolean

Default value is false.
carrier string

Default value is packeta.
deliveryPrice number(float)

Minimum value is 0. Default value is 29.0.
pickupPointId string | null
useCod boolean

Default value is false.
codPrice number(float)

Minimum value is 0. Default value is 79.0.
discount number(float)

Minimum value is 0. Default value is 0.0.
generateLabel boolean

Default value is true.
randomItemsCount integer

Minimum value is 1. Default value is 2.
customProducts object | null
Hide customProducts attribute Show customProducts attribute object | null
- * integer Additional properties

Responses

200 application/json

all products are returned with default page limit of 1000 items
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
400 application/json

On invalid JSON or variable type input, the 400 is returned
Hide response attribute Show response attribute object
- message string
403 application/json

If user does not have authorized access to selected sellingchannel or productset the 403 is returned
Hide response attribute Show response attribute object
- message string

POST /testing-order

curl \
 --request POST 'api.services.omnicado.com/api/v2/testing-order' \
 --header "X-OMNICADO-TOKEN: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"sellingChannelId":1234,"currency":"EUR","status":"shipped","useMarketplaceCarrier":false,"carrier":"gls","deliveryPrice":"222.2","pickupPointId":"ALZABOX0","useCod":true,"codPrice":59.0,"discount":120.0,"generateLabel":true,"randomItemsCount":2,"customProducts":{"3333":1,"4321":3}}'

Request examples

{
  "sellingChannelId": 1234,
  "currency": "EUR",
  "status": "shipped",
  "useMarketplaceCarrier": false,
  "carrier": "gls",
  "deliveryPrice": "222.2",
  "pickupPointId": "ALZABOX0",
  "useCod": true,
  "codPrice": 59.0,
  "discount": 120.0,
  "generateLabel": true,
  "randomItemsCount": 2,
  "customProducts": {
    "3333": 1,
    "4321": 3
  }
}

Response examples (200)

{
  "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"
    }
  ]
}

Response examples (400)

{
  "message": {
    "validation": "Validation error. The item 'randomItemsCount' expects to be int, 'this is a string' given."
  }
}

Response examples (403)

{
  "message": "Unauthorized. User has no access to the given Selling Channel and its Product Set"
}