---
title: "Search for orders"
method: GET
path: "/orders"
tags: ["orders"]
---

# Search for orders

`GET /orders`

This request retrieves a paginated list of orders that supports query, sorting, and pagination parameters to filter and structure the results.

## Query parameters

- `query` string
- `sort` string
- `page` integer
- `searchAfter` string
- `pageSize` integer

## Response `200`

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

- OrderSummary[]
  - `orderId` integer — The unique internal identifier for the order.
  - `sellerId` integer — 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` OrderAddressAdditionalIdentifier[] — Additional unique identifiers for the shipping address (e.g., GLN).
    - `identifier` string — The specific identifier string (e.g., a GLN or store ID).
    - `type` string — The type of the identifier (e.g., 'GLN', 'SHOP_SPECIFIC').
  - `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` TrackingSummary[] — A list of tracking numbers and links associated with shipments for this order.
    - `number` string — The tracking number for the shipment.
    - `link` string — The public tracking link URL provided by the carrier.
  - `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` PositionSummary[] — A summary list of the products originally ordered by the customer.
    - `positionId` integer — The unique internal identifier for the order position.
    - `positionIdentifier` string — A unique identifier for the position from the source system.
    - `name` string — The descriptive name of the ordered product.
    - `sku` string — The Stock Keeping Unit (SKU) of the ordered product.
    - `customAttributes` object — Arbitrary key-value pairs for storing custom data related to the position.
  - `fulfillmentOrders` FulfillmentOrderSummary[] — Details of how the order was split and planned for physical fulfillment in the warehouse(s).
    - `fulfillmentOrderIdentifier` string — The unique identifier for the fulfillment order in the warehouse system.
    - `fulfillmentStatus` string — The current status of the fulfillment order (e.g., 'READY_FOR_PICKING', 'SHIPPED').
    - `positions` FulfillmentOrderPositionSummary[] — Details of the items and quantities processed in this fulfillment order.
      - `fulfillmentOrderPositionId` integer — The unique internal identifier for the fulfillment order position.
      - `orderedSku` string — The SKU from the original order before any mapping or bundling.
      - `sku` string — The final SKU selected for fulfillment, after considering bundles/maps.
      - `warehouseSku` string — The SKU as known in the warehouse system.
      - `quantity` integer — The quantity of the item allocated for fulfillment.
      - `lot` string — The lot number of the item allocated.
      - `location` string — The warehouse location where the item is stored.
      - `customsValue` number — The value of the item used for customs declaration.
      - `expirationDate` string, date-time — The expiration date of the specific product batch used.
    - `shipments` ShipmentSummary[] — A list of shipments created as a result of this fulfillment order.
      - `shipmentId` integer — The unique internal identifier for the shipment.
      - `shipmentIdentifier` string — The unique reference for the shipment, typically assigned by the system.
      - `positions` ShipmentPositionDetail[] — The list of items and quantities contained within this specific shipment.
        - `shipmentPositionId` integer — The unique internal identifier for the shipment position.
        - `sku` string — The SKU used for the shipment position.
        - `warehouseSku` string — The SKU as known in the warehouse system.
        - `sellerSku` string — The original SKU from the seller.
        - `quantity` integer — The quantity shipped in this position.
        - `lot` string — The lot number of the item shipped.
        - `location` string — The storage location where the item was picked from.
        - `expirationDate` string, date-time — The expiration date of the product shipped.
        - `serialNumbers` string[] — A list of serial numbers for tracked items.
        - `positionIdentifier` string — The unique identifier for the shipment position.
  - `entityErrors` EntityErrorSummary[] — A list of critical errors preventing the fulfillment process.
    - `errorCode` string — A machine-readable code identifying the nature of the error (e.g., 'OUT_OF_STOCK').
    - `errorMessage` string — A human-readable message explaining the error in detail.
  - `sort` JsonNode
    - `float` boolean
    - `short` boolean
    - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
    - `number` boolean
    - `double` boolean
    - `binary` boolean
    - `integralNumber` boolean
    - `boolean` boolean
    - `long` boolean
    - `int` boolean
    - `valueNode` boolean
    - `containerNode` boolean
    - `missingNode` boolean
    - `object` boolean
    - `pojo` boolean
    - `floatingPointNumber` boolean
    - `bigDecimal` boolean
    - `bigInteger` boolean
    - `textual` boolean
    - `array` boolean
    - `null` boolean
  - `shopId` integer — 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.

---

[API](https://skmtc.net/writechoiceorg/apis/connector.md) · [All operations](https://skmtc.net/writechoiceorg/apis/connector/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/writechoiceorg/connector/versions/7ce09a4b2a4e/schema)