Skip to main content
POST
/
orders
Submit request
curl --request POST \
  --url https://api.quivo.co/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "sellerId": 123,
  "orderIdentifier": "<string>",
  "orderReference": "<string>",
  "deliveryAddress": {
    "name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "countryIso2": "<string>",
    "addressIdentifier": "<string>",
    "additionalIdentifiers": [
      {
        "identifier": "<string>",
        "type": "<string>"
      }
    ],
    "latitude": 123,
    "longitude": 123
  },
  "positions": [
    {
      "sku": "<string>",
      "name": "<string>",
      "quantity": 123,
      "price": 123,
      "lot": "<string>",
      "expirationDate": "2023-12-25",
      "location": "<string>",
      "positionIdentifier": "<string>",
      "productIdentifier": "<string>",
      "customAttributes": "{\"attr1\":\"val1\"}"
    }
  ],
  "warehouseId": 123,
  "hasInvoiceAddress": true,
  "hasInvoiceData": true,
  "invoiceAddress": {
    "name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "countryIso2": "<string>"
  },
  "orderDate": "2023-11-07T05:31:56Z",
  "currencyCode": "<string>",
  "invoiceIds": [
    "<string>"
  ],
  "comment": "<string>",
  "earliestDeliveryDate": "2023-12-25",
  "latestDeliveryDate": "2023-12-25",
  "transportInsuranceAmount": 1,
  "cashOnDeliveryAmount": 123,
  "cashOnDeliveryCurrency": "<string>",
  "shippingMethodIdentifier": "<string>",
  "shippingMethodName": "<string>",
  "tags": [
    "<string>"
  ],
  "trackingEnabled": true,
  "orderPriority": 2,
  "orderReference2": "<string>",
  "customerPurchaseOrderNumber": "<string>",
  "ssccLabel": true,
  "channelId": "<string>",
  "channelName": "<string>",
  "attachments": [
    {
      "printerType": "LABEL_PRINTER",
      "attachmentPlacement": "INSIDE_PACKAGE",
      "copyCount": 2,
      "filename": "<string>",
      "printingType": "ORDER",
      "fileKey": "<string>",
      "mimeType": "<string>"
    }
  ],
  "customAttributes": "{\"attr1\":\"val1\"}"
}
'
{
  "status": "<string>",
  "field": "<string>",
  "message": "<string>",
  "orderId": 123
}

Body

application/json

Request body data for Submit request

Request payload for creating a new order. Contains essential order details including delivery address, order identifier, item positions, shipping preferences, and optional customer information.

​
sellerId
integer<int64>
required

The seller id to which this order belongs.

​
orderIdentifier
string
required

A unique identifier to prevent duplicates of the same order in the system. It can be the id of the order in the shop system or another unique number

Maximum string length: 40
​
orderReference
string
required

The orderReference is set from the customer to identify the order easily. Example: #DE38678

Maximum string length: 40
​
deliveryAddress
object
required

Request object for creating orderdeliveryaddress

​
positions
object[]
required

The content of the order.

Required array length: 1 - 2147483647 elements
​
warehouseId
integer<int64>

The id of the warehouse where the order gets processed. A list of warehouse identifiers and names can be obtained by executing GET /warehouses

​
hasInvoiceAddress
boolean

Optional value indicating whether the invoice address is provided.
By default the delivery address is used as invoice address.

​
hasInvoiceData
boolean

Optional value indicating whether the invoice data is provided.
The invoice data includes currency and sales prices.

​
invoiceAddress
object

Request object for creating orderaddress

​
orderDate
string<date-time>

The date when the order was placed.

​
currencyCode
string

The currency in which the order was placed.

​
invoiceIds
string[]

The unique identifier for the invoices

​
comment
string

Optional text which contains instructions for the fulfillment and is sent to the warehouse.

Maximum string length: 250
​
earliestDeliveryDate
string<date>

Optional date which indicates the earliest allowed date of delivery in ISO 8601 format. Example: 2021-01-10

​
latestDeliveryDate
string<date>

Optional date which indicates the latest allowed date of delivery in ISO 8601 format. Example: 2021-01-12

​
transportInsuranceAmount
number

Optional amount which should get insured when booking the transport for this order in EUR.

Required range: x > 0
​
cashOnDeliveryAmount
number

Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment

​
cashOnDeliveryCurrency
string

Optional COD currency.

​
shippingMethodIdentifier
string

Optional identifier which indicates how the parcels should be transported. Example: UPSS

Maximum string length: 50
​
shippingMethodName
string

Optional name which indicates how the parcels should be transported. Example: UPS Saver

Maximum string length: 100
​
tags
string[]

Optional tags of this order

​
trackingEnabled
boolean

Optional value setting whether to turn on/off tracking functionality for an order. Additional charges will apply when set to true.

​
orderPriority
integer<int32>

Optional value to prioritize order.

Required range: 1 <= x <= 3
​
orderReference2
string

Optional value for additional orderReference Example: #DE38678

Maximum string length: 40
​
customerPurchaseOrderNumber
string

Optional value which specifies reference code that is assigned to a purchase Example: PO-89225

Maximum string length: 255
​
ssccLabel
boolean

Optional value setting whether to create ssccLabel or not based on customerPurchaseOrderNumber value.

​
channelId
string

Optional value which specifies the channel ID of the master client of this order.

Maximum string length: 10
​
channelName
string

Optional value which specifies the channel name of the master client of this order. Example: Obi E-Commerce

Maximum string length: 100
​
attachments
object[]

Optional attachments parameter

​
customAttributes
object

Optional value for custom attributes of order.

Example:

"{\"attr1\":\"val1\"}"

Response

Returns the result of the order creation attempt, including the newly assigned 'orderId' if successful, or status and error details if validation fails.

Represents the outcome of an order creation request, indicating whether the operation was successful (status) and, if successful, providing the new orderId. It includes fields for error messages if the operation failed.

​
status
string

Indicates the overall status of the order creation attempt. Typically "OK" on success, or an error status on failure.

​
field
string

On failure, this field indicates the specific request field that caused the error (e.g., "deliveryAddress.countryIso2"). This field is null on success.

​
message
string

A detailed, human-readable message describing the outcome of the operation. This may contain success confirmation or a specific error explanation.

​
orderId
integer<int64>

The unique internal ID assigned to the new order upon successful creation. This field is null on failure.