Submit request
curl --request POST \
--url https://api.quivo.co/v2/orders \
--header 'Authorization: Bearer <token>' \
--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,
"allowPartial": true,
"orderPriority": 2,
"orderReference2": "<string>",
"customerPurchaseOrderNumber": "<string>",
"customerPurchaseOrderNumber2": "<string>",
"ssccLabel": true,
"channelId": "<string>",
"channelName": "<string>",
"channelTypeCode": "<string>",
"attachments": [
{
"copyCount": 2,
"filename": "<string>",
"fileKey": "<string>",
"mimeType": "<string>"
}
],
"customAttributes": "{\"attr1\":\"val1\"}"
}
'import requests
url = "https://api.quivo.co/v2/orders"
payload = {
"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,
"allowPartial": True,
"orderPriority": 2,
"orderReference2": "<string>",
"customerPurchaseOrderNumber": "<string>",
"customerPurchaseOrderNumber2": "<string>",
"ssccLabel": True,
"channelId": "<string>",
"channelName": "<string>",
"channelTypeCode": "<string>",
"attachments": [
{
"copyCount": 2,
"filename": "<string>",
"fileKey": "<string>",
"mimeType": "<string>"
}
],
"customAttributes": "{\"attr1\":\"val1\"}"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
allowPartial: true,
orderPriority: 2,
orderReference2: '<string>',
customerPurchaseOrderNumber: '<string>',
customerPurchaseOrderNumber2: '<string>',
ssccLabel: true,
channelId: '<string>',
channelName: '<string>',
channelTypeCode: '<string>',
attachments: [
{copyCount: 2, filename: '<string>', fileKey: '<string>', mimeType: '<string>'}
],
customAttributes: '{"attr1":"val1"}'
})
};
fetch('https://api.quivo.co/v2/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quivo.co/v2/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'allowPartial' => true,
'orderPriority' => 2,
'orderReference2' => '<string>',
'customerPurchaseOrderNumber' => '<string>',
'customerPurchaseOrderNumber2' => '<string>',
'ssccLabel' => true,
'channelId' => '<string>',
'channelName' => '<string>',
'channelTypeCode' => '<string>',
'attachments' => [
[
'copyCount' => 2,
'filename' => '<string>',
'fileKey' => '<string>',
'mimeType' => '<string>'
]
],
'customAttributes' => '{"attr1":"val1"}'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.quivo.co/v2/orders"
payload := strings.NewReader("{\n \"sellerId\": 123,\n \"orderIdentifier\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"deliveryAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"addressIdentifier\": \"<string>\",\n \"additionalIdentifiers\": [\n {\n \"identifier\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"positions\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"lot\": \"<string>\",\n \"expirationDate\": \"2023-12-25\",\n \"location\": \"<string>\",\n \"positionIdentifier\": \"<string>\",\n \"productIdentifier\": \"<string>\",\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n }\n ],\n \"warehouseId\": 123,\n \"hasInvoiceAddress\": true,\n \"hasInvoiceData\": true,\n \"invoiceAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\"\n },\n \"orderDate\": \"2023-11-07T05:31:56Z\",\n \"currencyCode\": \"<string>\",\n \"invoiceIds\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"earliestDeliveryDate\": \"2023-12-25\",\n \"latestDeliveryDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\",\n \"shippingMethodIdentifier\": \"<string>\",\n \"shippingMethodName\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"trackingEnabled\": true,\n \"allowPartial\": true,\n \"orderPriority\": 2,\n \"orderReference2\": \"<string>\",\n \"customerPurchaseOrderNumber\": \"<string>\",\n \"customerPurchaseOrderNumber2\": \"<string>\",\n \"ssccLabel\": true,\n \"channelId\": \"<string>\",\n \"channelName\": \"<string>\",\n \"channelTypeCode\": \"<string>\",\n \"attachments\": [\n {\n \"copyCount\": 2,\n \"filename\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.quivo.co/v2/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sellerId\": 123,\n \"orderIdentifier\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"deliveryAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"addressIdentifier\": \"<string>\",\n \"additionalIdentifiers\": [\n {\n \"identifier\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"positions\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"lot\": \"<string>\",\n \"expirationDate\": \"2023-12-25\",\n \"location\": \"<string>\",\n \"positionIdentifier\": \"<string>\",\n \"productIdentifier\": \"<string>\",\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n }\n ],\n \"warehouseId\": 123,\n \"hasInvoiceAddress\": true,\n \"hasInvoiceData\": true,\n \"invoiceAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\"\n },\n \"orderDate\": \"2023-11-07T05:31:56Z\",\n \"currencyCode\": \"<string>\",\n \"invoiceIds\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"earliestDeliveryDate\": \"2023-12-25\",\n \"latestDeliveryDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\",\n \"shippingMethodIdentifier\": \"<string>\",\n \"shippingMethodName\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"trackingEnabled\": true,\n \"allowPartial\": true,\n \"orderPriority\": 2,\n \"orderReference2\": \"<string>\",\n \"customerPurchaseOrderNumber\": \"<string>\",\n \"customerPurchaseOrderNumber2\": \"<string>\",\n \"ssccLabel\": true,\n \"channelId\": \"<string>\",\n \"channelName\": \"<string>\",\n \"channelTypeCode\": \"<string>\",\n \"attachments\": [\n {\n \"copyCount\": 2,\n \"filename\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/v2/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sellerId\": 123,\n \"orderIdentifier\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"deliveryAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"addressIdentifier\": \"<string>\",\n \"additionalIdentifiers\": [\n {\n \"identifier\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"positions\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"lot\": \"<string>\",\n \"expirationDate\": \"2023-12-25\",\n \"location\": \"<string>\",\n \"positionIdentifier\": \"<string>\",\n \"productIdentifier\": \"<string>\",\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n }\n ],\n \"warehouseId\": 123,\n \"hasInvoiceAddress\": true,\n \"hasInvoiceData\": true,\n \"invoiceAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\"\n },\n \"orderDate\": \"2023-11-07T05:31:56Z\",\n \"currencyCode\": \"<string>\",\n \"invoiceIds\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"earliestDeliveryDate\": \"2023-12-25\",\n \"latestDeliveryDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\",\n \"shippingMethodIdentifier\": \"<string>\",\n \"shippingMethodName\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"trackingEnabled\": true,\n \"allowPartial\": true,\n \"orderPriority\": 2,\n \"orderReference2\": \"<string>\",\n \"customerPurchaseOrderNumber\": \"<string>\",\n \"customerPurchaseOrderNumber2\": \"<string>\",\n \"ssccLabel\": true,\n \"channelId\": \"<string>\",\n \"channelName\": \"<string>\",\n \"channelTypeCode\": \"<string>\",\n \"attachments\": [\n {\n \"copyCount\": 2,\n \"filename\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"field": "<string>",
"message": "<string>",
"orderId": 123
}orders
Submit request
Submit a new order for processing, including essential details like delivery address, order identifier, and item positions.
POST
/
orders
Submit request
curl --request POST \
--url https://api.quivo.co/v2/orders \
--header 'Authorization: Bearer <token>' \
--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,
"allowPartial": true,
"orderPriority": 2,
"orderReference2": "<string>",
"customerPurchaseOrderNumber": "<string>",
"customerPurchaseOrderNumber2": "<string>",
"ssccLabel": true,
"channelId": "<string>",
"channelName": "<string>",
"channelTypeCode": "<string>",
"attachments": [
{
"copyCount": 2,
"filename": "<string>",
"fileKey": "<string>",
"mimeType": "<string>"
}
],
"customAttributes": "{\"attr1\":\"val1\"}"
}
'import requests
url = "https://api.quivo.co/v2/orders"
payload = {
"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,
"allowPartial": True,
"orderPriority": 2,
"orderReference2": "<string>",
"customerPurchaseOrderNumber": "<string>",
"customerPurchaseOrderNumber2": "<string>",
"ssccLabel": True,
"channelId": "<string>",
"channelName": "<string>",
"channelTypeCode": "<string>",
"attachments": [
{
"copyCount": 2,
"filename": "<string>",
"fileKey": "<string>",
"mimeType": "<string>"
}
],
"customAttributes": "{\"attr1\":\"val1\"}"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
allowPartial: true,
orderPriority: 2,
orderReference2: '<string>',
customerPurchaseOrderNumber: '<string>',
customerPurchaseOrderNumber2: '<string>',
ssccLabel: true,
channelId: '<string>',
channelName: '<string>',
channelTypeCode: '<string>',
attachments: [
{copyCount: 2, filename: '<string>', fileKey: '<string>', mimeType: '<string>'}
],
customAttributes: '{"attr1":"val1"}'
})
};
fetch('https://api.quivo.co/v2/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quivo.co/v2/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'allowPartial' => true,
'orderPriority' => 2,
'orderReference2' => '<string>',
'customerPurchaseOrderNumber' => '<string>',
'customerPurchaseOrderNumber2' => '<string>',
'ssccLabel' => true,
'channelId' => '<string>',
'channelName' => '<string>',
'channelTypeCode' => '<string>',
'attachments' => [
[
'copyCount' => 2,
'filename' => '<string>',
'fileKey' => '<string>',
'mimeType' => '<string>'
]
],
'customAttributes' => '{"attr1":"val1"}'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.quivo.co/v2/orders"
payload := strings.NewReader("{\n \"sellerId\": 123,\n \"orderIdentifier\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"deliveryAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"addressIdentifier\": \"<string>\",\n \"additionalIdentifiers\": [\n {\n \"identifier\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"positions\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"lot\": \"<string>\",\n \"expirationDate\": \"2023-12-25\",\n \"location\": \"<string>\",\n \"positionIdentifier\": \"<string>\",\n \"productIdentifier\": \"<string>\",\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n }\n ],\n \"warehouseId\": 123,\n \"hasInvoiceAddress\": true,\n \"hasInvoiceData\": true,\n \"invoiceAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\"\n },\n \"orderDate\": \"2023-11-07T05:31:56Z\",\n \"currencyCode\": \"<string>\",\n \"invoiceIds\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"earliestDeliveryDate\": \"2023-12-25\",\n \"latestDeliveryDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\",\n \"shippingMethodIdentifier\": \"<string>\",\n \"shippingMethodName\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"trackingEnabled\": true,\n \"allowPartial\": true,\n \"orderPriority\": 2,\n \"orderReference2\": \"<string>\",\n \"customerPurchaseOrderNumber\": \"<string>\",\n \"customerPurchaseOrderNumber2\": \"<string>\",\n \"ssccLabel\": true,\n \"channelId\": \"<string>\",\n \"channelName\": \"<string>\",\n \"channelTypeCode\": \"<string>\",\n \"attachments\": [\n {\n \"copyCount\": 2,\n \"filename\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.quivo.co/v2/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sellerId\": 123,\n \"orderIdentifier\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"deliveryAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"addressIdentifier\": \"<string>\",\n \"additionalIdentifiers\": [\n {\n \"identifier\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"positions\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"lot\": \"<string>\",\n \"expirationDate\": \"2023-12-25\",\n \"location\": \"<string>\",\n \"positionIdentifier\": \"<string>\",\n \"productIdentifier\": \"<string>\",\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n }\n ],\n \"warehouseId\": 123,\n \"hasInvoiceAddress\": true,\n \"hasInvoiceData\": true,\n \"invoiceAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\"\n },\n \"orderDate\": \"2023-11-07T05:31:56Z\",\n \"currencyCode\": \"<string>\",\n \"invoiceIds\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"earliestDeliveryDate\": \"2023-12-25\",\n \"latestDeliveryDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\",\n \"shippingMethodIdentifier\": \"<string>\",\n \"shippingMethodName\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"trackingEnabled\": true,\n \"allowPartial\": true,\n \"orderPriority\": 2,\n \"orderReference2\": \"<string>\",\n \"customerPurchaseOrderNumber\": \"<string>\",\n \"customerPurchaseOrderNumber2\": \"<string>\",\n \"ssccLabel\": true,\n \"channelId\": \"<string>\",\n \"channelName\": \"<string>\",\n \"channelTypeCode\": \"<string>\",\n \"attachments\": [\n {\n \"copyCount\": 2,\n \"filename\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/v2/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sellerId\": 123,\n \"orderIdentifier\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"deliveryAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"addressIdentifier\": \"<string>\",\n \"additionalIdentifiers\": [\n {\n \"identifier\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"positions\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"lot\": \"<string>\",\n \"expirationDate\": \"2023-12-25\",\n \"location\": \"<string>\",\n \"positionIdentifier\": \"<string>\",\n \"productIdentifier\": \"<string>\",\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n }\n ],\n \"warehouseId\": 123,\n \"hasInvoiceAddress\": true,\n \"hasInvoiceData\": true,\n \"invoiceAddress\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\"\n },\n \"orderDate\": \"2023-11-07T05:31:56Z\",\n \"currencyCode\": \"<string>\",\n \"invoiceIds\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"earliestDeliveryDate\": \"2023-12-25\",\n \"latestDeliveryDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\",\n \"shippingMethodIdentifier\": \"<string>\",\n \"shippingMethodName\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"trackingEnabled\": true,\n \"allowPartial\": true,\n \"orderPriority\": 2,\n \"orderReference2\": \"<string>\",\n \"customerPurchaseOrderNumber\": \"<string>\",\n \"customerPurchaseOrderNumber2\": \"<string>\",\n \"ssccLabel\": true,\n \"channelId\": \"<string>\",\n \"channelName\": \"<string>\",\n \"channelTypeCode\": \"<string>\",\n \"attachments\": [\n {\n \"copyCount\": 2,\n \"filename\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"customAttributes\": \"{\\\"attr1\\\":\\\"val1\\\"}\"\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"field": "<string>",
"message": "<string>",
"orderId": 123
}Authorizations
Access token from POST /v2/oauth2/token, requested with an API credential. See https://api-docs.quivo.co/api-reference/authentication.
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.
The seller id to which this order belongs.
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:
40The orderReference is set from the customer to identify the order easily. Example: #DE38678
Maximum string length:
40Request object for creating orderdeliveryaddress
Show child attributes
Show child attributes
The content of the order.
Required array length:
1 - 2147483647 elementsShow child attributes
Show child attributes
The id of the warehouse where the order gets processed. A list of warehouse identifiers and names can be obtained by executing GET /warehouses
Optional value indicating whether the invoice address is provided.
By default the delivery address is used as invoice address.
Optional value indicating whether the invoice data is provided.
The invoice data includes currency and sales prices.
Request object for creating orderaddress
Show child attributes
Show child attributes
The date when the order was placed.
The currency in which the order was placed.
The unique identifier for the invoices
Optional text which contains instructions for the fulfillment and is sent to the warehouse.
Maximum string length:
250Optional date which indicates the earliest allowed date of delivery in ISO 8601 format. Example: 2021-01-10
Optional date which indicates the latest allowed date of delivery in ISO 8601 format. Example: 2021-01-12
Optional amount which should get insured when booking the transport for this order in EUR.
Required range:
x > 0Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment
Optional COD currency.
Optional identifier which indicates how the parcels should be transported. Example: UPSS
Maximum string length:
50Optional name which indicates how the parcels should be transported. Example: UPS Saver
Maximum string length:
100Optional tags of this order
Optional value setting whether to turn on/off tracking functionality for an order. Additional charges will apply when set to true.
Optional value setting whether the order may be fulfilled partially when not all items are in stock. Defaults to the seller setting.
Optional value to prioritize order.
Required range:
1 <= x <= 3Optional value for additional orderReference Example: #DE38678
Maximum string length:
40Optional value which specifies reference code that is assigned to a purchase Example: PO-89225
Maximum string length:
255Optional value which specifies a second reference code that is assigned to a purchase Example: PO-89225
Maximum string length:
255Optional value setting whether to create ssccLabel or not based on customerPurchaseOrderNumber value.
Optional value which specifies the channel ID of the master client of this order.
Maximum string length:
10Optional value which specifies the channel name of the master client of this order. Example: Obi E-Commerce
Maximum string length:
100Optional channel type of the order. Known values: 03 (Wholesale), 06 (E-Commerce), B2B, B2C. Any other value is ignored and the order is created without channel type.
Maximum string length:
3Optional attachments parameter
Show child attributes
Show child attributes
Optional value for custom attributes of order.
Show child attributes
Show child attributes
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.
Indicates the overall status of the order creation attempt. Typically "OK" on success, or an error status on failure.
On failure, this field indicates the specific request field that caused the error (e.g., "deliveryAddress.countryIso2"). This field is null on success.
A detailed, human-readable message describing the outcome of the operation. This may contain success confirmation or a specific error explanation.
The unique internal ID assigned to the new order upon successful creation. This field is null on failure.