Skip to main content
GET
/
orders
List orders
curl --request GET \
  --url https://api.quivo.co/orders
[
  {
    "orderId": 123,
    "sellerId": 123,
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "orderIdentifier": "<string>",
    "orderReference": "<string>",
    "orderStatus": "<string>",
    "tags": [
      "<string>"
    ],
    "orderDate": "2023-11-07T05:31:56Z",
    "cancelRequestedAt": "2023-11-07T05:31:56Z",
    "shipToCountry": "<string>",
    "shipToZip": "<string>",
    "shipToCompany": "<string>",
    "shipToName1": "<string>",
    "shipToName2": "<string>",
    "shipToAddressIdentifier": "<string>",
    "shipToAdditionalIdentifiers": [
      {
        "identifier": "<string>",
        "type": "<string>"
      }
    ],
    "earliestPredatedShipment": "2023-12-25",
    "latestPredatedShipment": "2023-12-25",
    "shipmentTracking": [
      {
        "number": "<string>",
        "link": "<string>"
      }
    ],
    "completedAt": "2023-11-07T05:31:56Z",
    "exportedAt": "2023-11-07T05:31:56Z",
    "shipToEmail": "<string>",
    "billToEmail": "<string>",
    "piiDataRemoved": true,
    "totalShipmentWeight": 123,
    "positions": [
      {
        "positionId": 123,
        "positionIdentifier": "<string>",
        "name": "<string>",
        "sku": "<string>",
        "customAttributes": {}
      }
    ],
    "fulfillmentOrders": [
      {
        "fulfillmentOrderId": 123,
        "fulfillmentOrderIdentifier": "<string>",
        "fulfillmentStatus": "<string>",
        "positions": [
          {
            "fulfillmentOrderPositionId": 123,
            "orderedSku": "<string>",
            "sku": "<string>",
            "warehouseSku": "<string>",
            "quantity": 123,
            "lot": "<string>",
            "location": "<string>",
            "customsValue": 123,
            "expirationDate": "2023-11-07T05:31:56Z"
          }
        ],
        "shipments": [
          {
            "shipmentId": 123,
            "shipmentIdentifier": "<string>",
            "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>"
              }
            ]
          }
        ]
      }
    ],
    "entityErrors": [
      {
        "errorCode": "<string>",
        "errorMessage": "<string>"
      }
    ],
    "sort": {
      "short": true,
      "nodeType": "ARRAY",
      "float": true,
      "binary": true,
      "number": true,
      "integralNumber": true,
      "boolean": true,
      "double": true,
      "long": true,
      "int": true,
      "valueNode": true,
      "containerNode": true,
      "missingNode": true,
      "object": true,
      "pojo": true,
      "floatingPointNumber": true,
      "bigDecimal": true,
      "bigInteger": true,
      "textual": true,
      "array": true,
      "null": true
    },
    "shopId": 123,
    "shopSystem": "<string>",
    "shopSystemName": "<string>",
    "customerPurchaseOrderNumber": "<string>",
    "channelId": "<string>",
    "channelName": "<string>",
    "customAttributes": {}
  }
]

Query Parameters

​
query
string

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

​
sort
string

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

​
page
integer<int64>

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

​
searchAfter
string

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

​
pageSize
integer<int64>

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

Returns an array of summarized order details, including key identifiers, status, and shipping information, filtered and sorted according to the request parameters.

​
orderId
integer<int64>

The unique internal identifier for the order.

​
sellerId
integer<int64>

The unique identifier for the seller account associated with the order.

​
created
string<date-time>

Timestamp when the order record was initially created.

​
lastModified
string<date-time>

Timestamp when the order record was last modified.

​
orderIdentifier
string

A unique identifier from the source system (e.g., shop system) to prevent duplicate order creation.

​
orderReference
string

An easy-to-read reference number for the order, typically set by the customer or shop.

​
orderStatus
string

The current fulfillment status of the order (e.g., 'PENDING', 'PROCESSING', 'COMPLETED').

​
tags
string[]

Optional list of descriptive tags applied to the order.

​
orderDate
string<date-time>

The date and time when the order was placed by the customer.

​
cancelRequestedAt
string<date-time>

Timestamp if a cancellation request was logged for the order.

​
shipToCountry
string

The ISO 2 country code (e.g., 'DE', 'US') for the delivery address.

​
shipToZip
string

The ZIP code for the delivery address.

​
shipToCompany
string

The company name for the delivery address.

​
shipToName1
string

The first name/line 1 name for the delivery address.

​
shipToName2
string

The second name/line 2 name for the delivery address.

​
shipToAddressIdentifier
string

An optional identifier for the delivery address (e.g., a store ID).

​
shipToAdditionalIdentifiers
object[]

Additional unique identifiers for the shipping address (e.g., GLN).

​
earliestPredatedShipment
string<date>

The earliest allowed date for the order to be shipped.

​
latestPredatedShipment
string<date>

The latest allowed date for the order to be shipped.

​
shipmentTracking
object[]

A list of tracking numbers and links associated with shipments for this order.

​
completedAt
string<date-time>

Timestamp when the order was marked as fulfilled/completed.

​
exportedAt
string<date-time>

Timestamp when the order was exported to the warehouse management system.

​
shipToEmail
string

The email address for the delivery recipient.

​
billToEmail
string

The email address for the invoice recipient.

​
piiDataRemoved
boolean

Indicates if Personally Identifiable Information (PII) has been removed from the order record.

​
totalShipmentWeight
number

The total weight of all shipments associated with the order (in kg).

​
positions
object[]

A summary list of the products originally ordered by the customer.

​
fulfillmentOrders
object[]

Details of how the order was split and planned for physical fulfillment in the warehouse(s).

​
entityErrors
object[]

A list of critical errors preventing the fulfillment process.

​
sort
object

Internal object used for controlling search result ordering.

​
shopId
integer<int64>

The unique identifier of the source shop system.

​
shopSystem
string

The technical name of the shop system (e.g., 'Shopware', 'Shopify').

​
shopSystemName
string

The display name of the shop system.

​
customerPurchaseOrderNumber
string

A reference code assigned to the purchase order by the customer.

​
channelId
string

The ID of the sales channel associated with the order.

​
channelName
string

The name of the sales channel associated with the order.

​
customAttributes
object

Arbitrary key-value pairs for storing custom data related to the order.