curl --request POST \
--url https://api.quivo.co/orders/extract \
--header 'Content-Type: application/octet-stream' \
--data '{}'import requests
url = "https://api.quivo.co/orders/extract"
payload = {}
headers = {"Content-Type": "application/octet-stream"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/octet-stream'},
body: JSON.stringify({})
};
fetch('https://api.quivo.co/orders/extract', 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/orders/extract",
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([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/octet-stream"
],
]);
$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/orders/extract"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/octet-stream")
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/orders/extract")
.header("Content-Type", "application/octet-stream")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/orders/extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/octet-stream'
request.body = "{}"
response = http.request(request)
puts response.read_body[
{
"orderId": 123,
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"orderIdentifier": "<string>",
"orderReference": "<string>",
"orderStatus": "<string>",
"orderDate": "2023-11-07T05:31:56Z",
"exportedAt": "2023-11-07T05:31:56Z",
"cancelRequestedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"customerIdentifier": "<string>",
"customerPurchaseOrderNumber": "<string>",
"ssccLabel": true,
"sellerId": 123,
"warehouseId": 123,
"sellerName": "<string>",
"shopAvailableAt": "<string>",
"shopActive": true,
"shopId": 123,
"shopSystem": "<string>",
"shopSystemName": "<string>",
"deliveryAddress": {
"name1": "<string>",
"name2": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>",
"addressIdentifier": "<string>",
"additionalIdentifiers": [
{
"identifier": "<string>",
"type": "<string>"
}
],
"latitude": 123,
"longitude": 123
},
"invoiceAddress": {
"name1": "<string>",
"name2": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"currency": "<string>",
"positions": [
{
"positionId": 123,
"positionIdentifier": "<string>",
"name": "<string>",
"sku": "<string>",
"customAttributes": {},
"productIdentifier": "<string>",
"variantIdentifier": "<string>",
"quantity": 123,
"lot": "<string>",
"location": "<string>",
"bundledBy": "<string>",
"unitWeight": 123,
"unitNetPrice": 123,
"unitGrossPrice": 123,
"totalWeight": 123,
"totalNetAmount": 123,
"totalGrossAmount": 123,
"expirationDate": "2023-11-07T05:31:56Z"
}
],
"fulfillmentOrders": [
{
"warehouseId": 123,
"warehouseName": "<string>",
"fulfillmentOrderId": 123,
"fulfillmentOrderIdentifier": "<string>",
"fulfillmentStatus": "<string>",
"fulfillmentConnectorStatus": "<string>",
"fulfillmentInStock": true,
"cancelled": true,
"positions": [
{
"fulfillmentOrderPositionId": 123,
"orderedSku": "<string>",
"sku": "<string>",
"warehouseSku": "<string>",
"quantity": 123,
"lot": "<string>",
"location": "<string>",
"customsValue": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"fulfillmentOrderPositionIdentifier": "<string>",
"bundleSku": "<string>"
}
],
"shipments": [
{
"shipmentId": 123,
"shipmentIdentifier": "<string>",
"provider": "<string>",
"trackingLink": "<string>",
"trackingLinks": [
"<string>"
],
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"shipDate": "2023-11-07T05:31:56Z",
"isUntracked": true,
"sscc": "<string>",
"predatedShipment": "2023-12-25",
"carrierPickUpDate": "2023-11-07T05:31:56Z",
"deliveryWindowStartTime": "2023-11-07T05:31:56Z",
"deliveryWindowEndTime": "2023-11-07T05:31:56Z",
"providerName": "<string>",
"numberOfPallets": 123,
"numberOfParcels": 123,
"grossWeight": 123,
"width": {
"value": 123
},
"length": {
"value": 123
},
"height": {
"value": 123
},
"positions": [
{
"shipmentPositionId": 123,
"sku": "<string>",
"warehouseSku": "<string>",
"sellerSku": "<string>",
"quantity": 123,
"lot": "<string>",
"location": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
],
"positionIdentifier": "<string>"
}
],
"reversed": true,
"bookedShipmentId": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"podDate": "2023-11-07T05:31:56Z",
"groupedPositions": [
{
"warehouseSku": "<string>",
"sellerSku": "<string>",
"quantity": 123,
"lot": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
]
}
],
"podDocuments": [
{
"fileName": "<string>",
"fileKey": "<string>",
"url": {
"link": "<string>"
},
"mimeType": "<string>"
}
]
}
],
"fulfillmentOrderCreated": "2023-11-07T05:31:56Z",
"inPicking": true
}
],
"handlingUnits": [
{
"sscc": "<string>",
"carrier": "<string>",
"tracking": "<string>",
"handlingUnitIdentifier": "<string>",
"truckHandlingUnitIdentifier": "<string>",
"handlingPositions": [
{
"sscc": "<string>",
"positionIdentifier": "<string>",
"sku": "<string>",
"warehouseSku": "<string>",
"quantity": 123
}
],
"childHandlingUnits": "<array>"
}
],
"earliestDeliveryDate": "2023-12-25",
"latestDeliveryDate": "2023-12-25",
"comment": "<string>",
"transportInsuranceAmount": 123,
"cashOnDeliveryAmount": 123,
"cashOnDeliveryCurrency": "<string>",
"deliveryInstruction": "<string>",
"shippingMethodIdentifier": "<string>",
"shippingMethodName": "<string>",
"tags": [
"<string>"
],
"earliestShipDate": "2023-12-25",
"latestShipDate": "2023-12-25",
"piiDataRemoved": true,
"paymentType": "<string>",
"trackingEnabled": true,
"orderPriority": 123,
"fulfillmentConfirmed": true,
"entityErrors": [
{
"errorCode": "<string>",
"errorMessage": "<string>"
}
],
"customAttributes": {}
}
]Create order
Extract or export orders based on filters for reporting or integration use cases.
curl --request POST \
--url https://api.quivo.co/orders/extract \
--header 'Content-Type: application/octet-stream' \
--data '{}'import requests
url = "https://api.quivo.co/orders/extract"
payload = {}
headers = {"Content-Type": "application/octet-stream"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/octet-stream'},
body: JSON.stringify({})
};
fetch('https://api.quivo.co/orders/extract', 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/orders/extract",
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([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/octet-stream"
],
]);
$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/orders/extract"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/octet-stream")
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/orders/extract")
.header("Content-Type", "application/octet-stream")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/orders/extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/octet-stream'
request.body = "{}"
response = http.request(request)
puts response.read_body[
{
"orderId": 123,
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"orderIdentifier": "<string>",
"orderReference": "<string>",
"orderStatus": "<string>",
"orderDate": "2023-11-07T05:31:56Z",
"exportedAt": "2023-11-07T05:31:56Z",
"cancelRequestedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"customerIdentifier": "<string>",
"customerPurchaseOrderNumber": "<string>",
"ssccLabel": true,
"sellerId": 123,
"warehouseId": 123,
"sellerName": "<string>",
"shopAvailableAt": "<string>",
"shopActive": true,
"shopId": 123,
"shopSystem": "<string>",
"shopSystemName": "<string>",
"deliveryAddress": {
"name1": "<string>",
"name2": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>",
"addressIdentifier": "<string>",
"additionalIdentifiers": [
{
"identifier": "<string>",
"type": "<string>"
}
],
"latitude": 123,
"longitude": 123
},
"invoiceAddress": {
"name1": "<string>",
"name2": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"currency": "<string>",
"positions": [
{
"positionId": 123,
"positionIdentifier": "<string>",
"name": "<string>",
"sku": "<string>",
"customAttributes": {},
"productIdentifier": "<string>",
"variantIdentifier": "<string>",
"quantity": 123,
"lot": "<string>",
"location": "<string>",
"bundledBy": "<string>",
"unitWeight": 123,
"unitNetPrice": 123,
"unitGrossPrice": 123,
"totalWeight": 123,
"totalNetAmount": 123,
"totalGrossAmount": 123,
"expirationDate": "2023-11-07T05:31:56Z"
}
],
"fulfillmentOrders": [
{
"warehouseId": 123,
"warehouseName": "<string>",
"fulfillmentOrderId": 123,
"fulfillmentOrderIdentifier": "<string>",
"fulfillmentStatus": "<string>",
"fulfillmentConnectorStatus": "<string>",
"fulfillmentInStock": true,
"cancelled": true,
"positions": [
{
"fulfillmentOrderPositionId": 123,
"orderedSku": "<string>",
"sku": "<string>",
"warehouseSku": "<string>",
"quantity": 123,
"lot": "<string>",
"location": "<string>",
"customsValue": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"fulfillmentOrderPositionIdentifier": "<string>",
"bundleSku": "<string>"
}
],
"shipments": [
{
"shipmentId": 123,
"shipmentIdentifier": "<string>",
"provider": "<string>",
"trackingLink": "<string>",
"trackingLinks": [
"<string>"
],
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"shipDate": "2023-11-07T05:31:56Z",
"isUntracked": true,
"sscc": "<string>",
"predatedShipment": "2023-12-25",
"carrierPickUpDate": "2023-11-07T05:31:56Z",
"deliveryWindowStartTime": "2023-11-07T05:31:56Z",
"deliveryWindowEndTime": "2023-11-07T05:31:56Z",
"providerName": "<string>",
"numberOfPallets": 123,
"numberOfParcels": 123,
"grossWeight": 123,
"width": {
"value": 123
},
"length": {
"value": 123
},
"height": {
"value": 123
},
"positions": [
{
"shipmentPositionId": 123,
"sku": "<string>",
"warehouseSku": "<string>",
"sellerSku": "<string>",
"quantity": 123,
"lot": "<string>",
"location": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
],
"positionIdentifier": "<string>"
}
],
"reversed": true,
"bookedShipmentId": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"podDate": "2023-11-07T05:31:56Z",
"groupedPositions": [
{
"warehouseSku": "<string>",
"sellerSku": "<string>",
"quantity": 123,
"lot": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
]
}
],
"podDocuments": [
{
"fileName": "<string>",
"fileKey": "<string>",
"url": {
"link": "<string>"
},
"mimeType": "<string>"
}
]
}
],
"fulfillmentOrderCreated": "2023-11-07T05:31:56Z",
"inPicking": true
}
],
"handlingUnits": [
{
"sscc": "<string>",
"carrier": "<string>",
"tracking": "<string>",
"handlingUnitIdentifier": "<string>",
"truckHandlingUnitIdentifier": "<string>",
"handlingPositions": [
{
"sscc": "<string>",
"positionIdentifier": "<string>",
"sku": "<string>",
"warehouseSku": "<string>",
"quantity": 123
}
],
"childHandlingUnits": "<array>"
}
],
"earliestDeliveryDate": "2023-12-25",
"latestDeliveryDate": "2023-12-25",
"comment": "<string>",
"transportInsuranceAmount": 123,
"cashOnDeliveryAmount": 123,
"cashOnDeliveryCurrency": "<string>",
"deliveryInstruction": "<string>",
"shippingMethodIdentifier": "<string>",
"shippingMethodName": "<string>",
"tags": [
"<string>"
],
"earliestShipDate": "2023-12-25",
"latestShipDate": "2023-12-25",
"piiDataRemoved": true,
"paymentType": "<string>",
"trackingEnabled": true,
"orderPriority": 123,
"fulfillmentConfirmed": true,
"entityErrors": [
{
"errorCode": "<string>",
"errorMessage": "<string>"
}
],
"customAttributes": {}
}
]Body
Data to create a new resource at /orders/extract
Request payload for extracting or exporting orders. Contains filter criteria and export configuration for retrieving order data in bulk.
Response
Returns the newly created OrderDetail with assigned identifiers and current state.
The unique identifier for the order
Timestamp when the item was created
Timestamp when the item was last modified
The unique identifier for the orderentifier
Reference number or identifier for the order
The current status of the order
The order date date
The exported at timestamp
The cancel requested at timestamp
The completed at timestamp
The unique identifier for the customerentifier
Number value
Boolean flag indicating sscc label
The unique identifier for the seller
The unique identifier for the warehouse
The name of the seller
The shop available at
Indicates whether the shop is active
The unique identifier for the shop
The shop system
The name of the shop system
Detailed delivery address information
Show child attributes
Show child attributes
Detailed address information
Show child attributes
Show child attributes
Currency code
Array of position items
Show child attributes
Show child attributes
Order identifier or information
Show child attributes
Show child attributes
Array of handling unit
Show child attributes
Show child attributes
The earliest delivery date date
The latest delivery date date
Comment or notes
Amount value
Amount value
Currency code
The delivery instruction
The unique identifier for the shippingmethodentifier
The name of the shipping method
Tags or labels
The earliest ship date date
The latest ship date date
Boolean flag indicating pii data removed
The type or category of the payment
Indicates whether tracking is enabled
Order identifier or information
Boolean flag indicating fulfillment confirmed
Error information
Show child attributes
Show child attributes
Custom attributes or data
Show child attributes
Show child attributes