---
title: "Retrieve List of Orders"
method: GET
path: "/v1/integrations/orders-list"
tags: ["Orders"]
---

# Retrieve List of Orders

`GET /v1/integrations/orders-list`

When no filters are specified, the endpoint will return up to the first 1,000,000 orders, based on selected ordering. If filters are used, this endpoint will return a maximum of 10,000 orders.

## Query parameters

- `page` integer
- `pageSize` integer
- `sortOrder` 'DESC' | 'ASC'
- `orderKeys` string[], nullable
- `orderNumbers` string[], nullable
- `orderStatus` 'unfulfilled' | 'fulfilled' | 'onHold' | 'cancelled'
- `orderType` 'direct_to_consumer' | 'retail' | 'amazon' | 'transfer' | 'internal_warehouse_transfer' | 'removal_liquidation' | 'disposal' | 'bonded_inventory_clearance' | 'work_order'
- `updatedAtStart` string, date-time
- `updatedAtEnd` string, date-time
- `shippedAtStart` string, date-time
- `shippedAtEnd` string, date-time

## Response `200`

Success

- object
  - `status` integer, required
  - `data` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderListPublicApiOrderListOutput, required
    - `orders` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderDetailOutput[], required — Orders matching the request criteria for the current page.
      - `order_key` string, required — Unique identifier from an external system used to associate an order. Must be unique per order and store.
      - `order_number` string, required — Customer-facing identifier for an order. Uniqueness is recommended but not strictly enforced.
      - `order_type` 'direct_to_consumer' | 'retail' | 'amazon' | 'transfer' | 'internal_warehouse_transfer' | 'removal_liquidation' | 'disposal' | 'bonded_inventory_clearance' | 'work_order', required
      - `store` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiStoreNameOutput, required
        - `id` integer, required — Internal numeric identifier of the store.
        - `name` string, required — Display name of the store.
      - `warehouse` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiWarehouseDetailOutput, required
        - `identifier` string, required — Short human-readable code identifying the warehouse.
        - `id` integer, required — Internal numeric identifier of the warehouse.
        - `name` string, required — Display name of the warehouse.
        - `warehouse_wms_type` 'shipmonk' | 'deposco' | 'merchant_facility', required
      - `trading_partner` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiAccountTradingPartnerOutput, required
        - `id` integer, required — Internal numeric identifier of the trading partner.
        - `identifier` string, required — Short human-readable code identifying the trading partner.
        - `name` string, required — Display name of the trading partner.
        - `account` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiAccountForTradingPartnerOutput, required
          - `id` integer, required — Internal numeric identifier of the merchant account.
          - `name` string, required — Display name of the merchant account.
      - `ordered_at` string, date-time, required — ISO 8601 timestamp indicating when the order was originally placed.
      - `customer_email` string, nullable, required — Customer's email address. Null when not provided by the source system.
      - `shipping_method` FulfillmentPublicApiBundleApiResourceShippingMethodPublicApiShippingMethodDetailOutput, required
        - `id` integer, required
        - `name` string, required
        - `carrier` FulfillmentPublicApiBundleApiResourceCarrierPublicApiCarrierDetailOutput, required
          - `id` integer, required
          - `name` string, required
      - `requested_shipping_service` string, nullable, required — Free-text shipping service originally requested by the customer or source system; null if none was specified.
      - `shipping_paid` number, double, required — Amount the customer paid for shipping, expressed in the order's currency_code.
      - `tax_paid` number, double, required — Amount the customer paid in taxes, expressed in the order's currency_code.
      - `order_costs` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderCostsOutput, required
        - `estimated_shipping_related_charges` ShipMonkMoneyOutputMoneyOutput, required
          - `amount` number, double, required — Decimal monetary amount in the currency given by the sibling currency field.
          - `currency` string, required — ISO 4217 currency code (e.g. USD, EUR) for the accompanying amount.
        - `estimated_packaging_material_charges` ShipMonkMoneyOutputMoneyOutput, required
          - `amount` number, double, required — Decimal monetary amount in the currency given by the sibling currency field.
          - `currency` string, required — ISO 4217 currency code (e.g. USD, EUR) for the accompanying amount.
        - `estimated_pick_and_pack_charges` ShipMonkMoneyOutputMoneyOutput, required
          - `amount` number, double, required — Decimal monetary amount in the currency given by the sibling currency field.
          - `currency` string, required — ISO 4217 currency code (e.g. USD, EUR) for the accompanying amount.
      - `ship_from` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiShippingOrderDetailAddressOutput, required
        - `name` string, nullable, required — Full name of the recipient or contact at this address.
        - `company` string, nullable, required — Company name at this address, if any.
        - `street1` string, nullable, required — Primary street address line (e.g. number and street).
        - `street2` string, nullable, required — Secondary street address line (e.g. apartment, suite, or unit).
        - `state` string, nullable, required — State, province, or region of the address.
        - `city` string, nullable, required — City or locality of the address.
        - `zip` string, nullable, required — Postal or ZIP code of the address.
        - `country_code` string, nullable, required — ISO 3166-1 alpha-2 country code (e.g. US, DE).
        - `phone` string, nullable, required — Contact phone number for the address.
        - `email` string, nullable, required — Contact email for the address.
        - `residential` boolean, nullable, required — true if the address is residential, false if commercial, null if unknown.
      - `ship_to` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiShippingOrderDetailAddressOutput, required
        - `name` string, nullable, required — Full name of the recipient or contact at this address.
        - `company` string, nullable, required — Company name at this address, if any.
        - `street1` string, nullable, required — Primary street address line (e.g. number and street).
        - `street2` string, nullable, required — Secondary street address line (e.g. apartment, suite, or unit).
        - `state` string, nullable, required — State, province, or region of the address.
        - `city` string, nullable, required — City or locality of the address.
        - `zip` string, nullable, required — Postal or ZIP code of the address.
        - `country_code` string, nullable, required — ISO 3166-1 alpha-2 country code (e.g. US, DE).
        - `phone` string, nullable, required — Contact phone number for the address.
        - `email` string, nullable, required — Contact email for the address.
        - `residential` boolean, nullable, required — true if the address is residential, false if commercial, null if unknown.
      - `order_status` 'unfulfilled' | 'fulfilled' | 'onHold' | 'cancelled', required
      - `processing_status` 'backorder' | 'unable_to_submit' | 'queued_to_submit' | 'subscription' | 'package_forwarding' | 'awaiting_self_fulfillment' | 'on_hold' | 'submitted' | 'pick_in_progress' | 'pack_in_progress' | 'packed' | 'awaiting_pick_up' | 'awaiting_carrier_processing' | 'en_route' | 'delivered' | 'undeliverable' | 'shipped_untrackable' | 'fulfilled_by_3rd' | 'cancellation_requested' | 'cancelled' | 'updating', required
      - `items` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderItemOutput[], required — Line items (SKUs and quantities) included in the order.
        - `line_key` string, nullable, required — External system identifier for this order line, unique within the order. Null when not provided.
        - `sku` string, required — Stock Keeping Unit (SKU) identifying the marketplace item being ordered.
        - `name` string, nullable, required — Display name of the marketplace item as captured on the order line.
        - `quantity` integer, required — Number of units of this SKU ordered.
        - `price` number, double, nullable, required — Per-unit price charged to the customer, in the order's currency_code. Null when not provided.
        - `image_url` string, nullable, required — Absolute URL of the marketplace item image, if available.
        - `fulfilled_quantity` integer, nullable, required — Number of units already shipped (fulfilled) for this line. Null if fulfillment has not started.
        - `source` 'imported' | 'manual' | 'inserted' | 'packaging' | 'claim_reship', required
        - `products` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderItemProductOutput[], required — Physical products allocated to fulfill this order line. A line with a bundle SKU may resolve to multiple component products.
          - `sku` string, required — Stock Keeping Unit (SKU) identifying the product being ordered.
          - `quantity` integer, required — Number of units of this physical product allocated to the order line.
          - `backordered_quantity` integer, required — Number of units of this product that could not be allocated because of insufficient stock.
          - `lot` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderItemProductLotOutput, required
            - `number` string, nullable, required — Lot (batch) number assigned to the product. Null when the lot has no number recorded.
            - `expiration_date` string, date, nullable, required — Lot expiration date in ISO 8601 format (YYYY-MM-DD), or null if not applicable.
          - `other_potential_lots` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderItemProductLotOutput[], required — Other inventory lots that could alternatively be used to fulfill this product.
            - `number` string, nullable, required — Lot (batch) number assigned to the product. Null when the lot has no number recorded.
            - `expiration_date` string, date, nullable, required — Lot expiration date in ISO 8601 format (YYYY-MM-DD), or null if not applicable.
      - `attributes` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderAttributeOutput[], required — Custom key/value attributes attached to the order by the merchant or source system.
        - `name` string, required — Key of the custom attribute.
        - `value` string, required — Value of the custom attribute.
      - `currency_code` string, required — ISO 4217 currency code used for all monetary values on the order.
      - `references` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderReferenceOutput[], required — Additional external reference identifiers attached to the order (e.g. PO number, marketplace reference).
        - `type` 'order_number' | 'original_imported_order_number' | 'customer_order_number' | 'po_number' | 'reference_number' | 'b2b_routing_reference' | 'release_number' | 'job_number' | 'depositor_order_number', required
        - `value` string, required — The reference identifier value, interpreted according to type.
      - `custom_data` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderDetailCustomDataOutput[], required — Custom key-value data associated with the order.
        - `name` string, required — Key name of the custom data entry.
        - `value` string, required — Value of the custom data entry.
      - `special_requirements` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiSpecialRequirementsOutput, required
        - `special_instruction` string, nullable, required — Free-text special handling instructions for the order, or null if none.
        - `carton_labels` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiSpecialInstructionNameUrlOutput[], required — Carton labels (name and download URL) that must be applied to the order's cartons.
          - `name` string, nullable, required — Human-readable name or description of the document; null if unnamed.
          - `url` string, required — URL from which the document file can be downloaded.
        - `additional_documents` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiSpecialInstructionNameUrlOutput[], required — Additional documents (name and download URL) that must accompany the order.
          - `name` string, nullable, required — Human-readable name or description of the document; null if unnamed.
          - `url` string, required — URL from which the document file can be downloaded.
        - `shipping_label` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiShippingLabelOutput, required
          - `url` string, required — URL from which the customer-provided shipping label can be downloaded.
        - `shipping_date` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiSpecialInstructionDateOutput, required
          - `earliest` string, date-time, nullable, required — Earliest acceptable date for the event (ISO-8601 date); null if no lower bound.
          - `requested` string, date-time, nullable, required — Preferred target date for the event (ISO-8601 date); null if not specified.
          - `latest` string, date-time, nullable, required — Latest acceptable date for the event (ISO-8601 date); null if no upper bound.
        - `delivery_date` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiSpecialInstructionDateOutput, required
          - `earliest` string, date-time, nullable, required — Earliest acceptable date for the event (ISO-8601 date); null if no lower bound.
          - `requested` string, date-time, nullable, required — Preferred target date for the event (ISO-8601 date); null if not specified.
          - `latest` string, date-time, nullable, required — Latest acceptable date for the event (ISO-8601 date); null if no upper bound.
        - `cancel_date` string, date-time, nullable, required — Date (ISO-8601) after which the order should be cancelled if not yet shipped; null if no cutoff.
        - `pack_list_required` boolean, required — True if a packing list document must be included with the shipment.
      - `actions_required` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderActionsRequiredOutput, required
        - `item_mapping` boolean, required — True if one or more order items could not be mapped to a known product and require manual mapping.
        - `address` boolean, required — True if the shipping address could not be validated and requires correction.
        - `shipping_mapping` boolean, required — True if the requested shipping service could not be mapped to an available carrier service and requires manual mapping.
        - `customs` boolean, required — True if customs information (e.g. declared value, HS codes) is missing or incomplete for an international shipment.
        - `at_risk` boolean, required — True if the order is at risk of missing its required ship-by date.
        - `routing` boolean, required — True if a B2B routing instruction is missing and must be supplied before shipping.
        - `freight_quote` boolean, required — True if a freight quote must be selected before the order can ship.
        - `freight_info` boolean, required — True if additional freight details (e.g. dimensions, pallet count) are required to obtain a freight quote.
        - `ship_short` boolean, required — True if the order is flagged as a short ship, meaning one or more items could not be fulfilled in the requested quantity.
        - `hs_code` boolean, required — True if Harmonized System (HS) tariff codes are missing for one or more items on a customs-bound shipment.
        - `global_e_label` boolean, required — True if a Global-e label (cross-border shipping label provided by the Global-e service) is still required for the order.
        - `ship_monk_hazmat_carrier_service_not_available` boolean, required — Deprecated: Will always be false, kept for backwards compatibility True if the order contains hazardous materials but no carrier service is available to ship them from the assigned warehouse.
        - `automation_rule` boolean, required — True if an automation rule has flagged the order for manual review or action.
        - `pending_b2b_routing` boolean, required — True if the order is awaiting B2B retailer routing instructions before fulfillment can proceed.
        - `value_added_service_problem` boolean, required — True if one of the order's value-added services (e.g. kitting, custom packaging) cannot be performed and needs attention.
      - `master_tracking_number` string, nullable, required — Master tracking number that groups all packages of a multi-piece shipment; null when not applicable.
      - `tracking_url` string, nullable, required — Carrier URL where the customer can track the shipment; null if not yet available.
      - `returns` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderReturnDataOutput[], required — Return Merchandise Authorizations (RMAs) created for this order.
        - `rma` string, required — Return Merchandise Authorization (RMA) number identifying this return.
      - `packages` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderPackageDataOutput[], required — Per-package fulfillment data, including tracking numbers, weights, and packed contents.
        - `number` integer, nullable, required — Sequential index (1-based) of this package within the order; null if not assigned.
        - `tracking_number` string, nullable, required — Carrier tracking number for this package; null if not yet generated or untrackable.
        - `tracking_url` string, nullable, required — Carrier URL for tracking this package; null if not yet available.
        - `weight_lb` ShipMonkMeasurementOutputWeightOutput, required
          - `value` number, double, required — Numeric weight value, expressed in the unit given by the unit field.
          - `unit` 'kg' | 'g' | 'lb' | 'oz', required
        - `pallet_weight_lb` ShipMonkMeasurementOutputWeightOutput, required
          - `value` number, double, required — Numeric weight value, expressed in the unit given by the unit field.
          - `unit` 'kg' | 'g' | 'lb' | 'oz', required
        - `pallet_number` integer, nullable, required — Index (1-based) of the pallet that contains this package; null if not palletized.
        - `box_number` integer, nullable, required — Index (1-based) of the box within its pallet; null if not palletized.
        - `carton_labels` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiPackageCartonLabelOutput[], required — Carton-level labels (e.g. packing slip, pallet label) applied to this package.
          - `type` 'shipmonk_pack_list_order_level' | 'shipmonk_pack_list_carton_level' | 'retailer_packing_slip_order_level' | 'shipmonk_carton_label' | 'shipmonk_pallet_label' | 'gs1_label' | 'shipmonk_gs1' | 'customized_carton_labels' | 'liquid_iv_packing_list' | 'custom_pack_list_order_level' | 'special_instructions', required
          - `identifier` string, nullable, required — Identifier printed on the label (e.g. SSCC); null if the label type has no identifier.
        - `packed_products` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiPackedProductOutput[], required — Products contained in this package, aggregated by SKU with packed quantities and lot details.
          - `sku` string, required — Stock-keeping unit (SKU) of the product packed in this package.
          - `quantity` integer, required — Number of units of this SKU packed in this package.
          - `lots` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderItemProductLotOutput[], required — Lot/batch identifiers and quantities for the packed units, when lot tracking applies.
            - `number` string, nullable, required — Lot (batch) number assigned to the product. Null when the lot has no number recorded.
            - `expiration_date` string, date, nullable, required — Lot expiration date in ISO 8601 format (YYYY-MM-DD), or null if not applicable.
        - `packing_group` FulfillmentIntegrationsBundleApiResourceOutputOrderPackingGroupOutput, required
          - `key` string, required — Stable identifier of the packing group, unique within the order.
          - `name` string, nullable, required — Human-readable name of the packing group; null if unnamed.
        - `packed_items` FulfillmentIntegrationsBundleApiResourceOutputOrderOrderPackedItemOutput[], required — Order line items packed in this package, with per-line quantities.
          - `sku` string, required — Stock-keeping unit (SKU) of the order item that was packed.
          - `line_key` string, nullable, required — Identifier of the order line this packed item refers to; null when the packed item is not tied to a specific line.
          - `quantity` integer, required — Number of units of this SKU packed in this package.
      - `tax_id` FulfillmentPublicApiBundleApiResourceOrderPublicApiOrderTaxIdOutput, required
        - `tax_id_type` 'VAT' | 'IOSS' | 'TIN' | 'EIN' | 'EORI' | 'ARN' | 'RFC' | 'CPF' | 'CNPJ' | 'PCCC' | 'VOEC', required
        - `value` string, required — Tax identification number, formatted according to its type and issuing country.
        - `issuing_country` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiCountryDetailOutput, required
          - `code` string, nullable, required — ISO 3166-1 alpha-2 country code; null if unknown.
          - `name` string, nullable, required — Country name in English; null if unknown.
      - `recipient_tax_id` FulfillmentPublicApiBundleApiResourceOrderPublicApiOrderTaxIdOutput, required
        - `tax_id_type` 'VAT' | 'IOSS' | 'TIN' | 'EIN' | 'EORI' | 'ARN' | 'RFC' | 'CPF' | 'CNPJ' | 'PCCC' | 'VOEC', required
        - `value` string, required — Tax identification number, formatted according to its type and issuing country.
        - `issuing_country` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiCountryDetailOutput, required
          - `code` string, nullable, required — ISO 3166-1 alpha-2 country code; null if unknown.
          - `name` string, nullable, required — Country name in English; null if unknown.
      - `shipment_data` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiShipmentDataOutput, required
        - `carrier` union, required — Name of the carrier handling the shipment. For standard shipments it is one value from the list. In cases involving custom labels or freight shipments, the field may contain values outside of this list.
          - 'CanadaPost' | 'Cirro' | 'DHL eCommerce' | 'DHL Express' | 'DPD' | 'FedEx' | 'Global-E' | 'International Bridge' | 'OnTrac' | 'Passport' | 'Royal Mail' | 'ShipMonk' | 'SpeedX' | 'UPS' | 'USPS'
          - string
        - `service` string, nullable, required — Carrier service level used (e.g. Ground, Express); null if the carrier does not report a service level.
        - `carrier_tracking_url` string, nullable, required — Public URL provided by the carrier to track the shipment; null if not available.
        - `carrier_alpha_code` string, nullable, required — Carrier's Standard Carrier Alpha Code (SCAC), a 2-4 letter identifier; null if not assigned.
        - `carrier_trans_method_code` string, nullable, required — Carrier transportation method code (e.g. air, ground, ocean); null if not provided by the carrier.
        - `bill_of_lading_number` string, nullable, required — Bill of lading (BOL) number, the transport document identifier issued by the carrier; null if not yet assigned.
        - `master_bill_of_lading_number` string, nullable, required — Master bill of lading number grouping multiple BOLs under a consolidated shipment; null if not consolidated.
        - `load_number` string, nullable, required — Carrier-assigned load number identifying the freight load this shipment belongs to; null if not provided.
        - `authorization_number` string, nullable, required — Carrier authorization number (e.g. PRO or pickup authorization) issued for the shipment; null if not provided.
        - `estimated_shipping_cost` number, double, nullable, required — Estimated shipping cost in the order's currency; null if not yet calculated.
        - `routing` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiRoutingDataOutput, required
          - `routing_key` string, required — Identifier of the routing instructions assigned to this shipment (used to match retailer routing guides).
      - `order_parts` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderPartOutput, required
        - `main_order` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderPartMainOrderOutput, required
          - `order_number` string, required — Order number of the main order this part was split from.
          - `parts` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiOrderPartItemOutput[], required — List of all part orders created from splitting the main order.
            - `order_number` string, required — Order number of this part order.
      - `shipped_at` string, date-time, nullable, required — ISO 8601 timestamp of when the order was shipped; null if not yet shipped.
      - `updated_at` string, date-time, nullable, required — ISO 8601 timestamp of when the order was last updated; null if never updated since creation.
      - `order_size` 'unknown' | 'regular' | 'oversized_item' | 'large' | 'extra_large', required
      - `extra_data` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiExtraDataOutput[], required — Additional key/value attributes attached to the shipment notification (e.g. carrier shipping method).
        - `label` 'carrierShippingMethod', required
        - `value` string, required — Value corresponding to the label of the extra data entry.
      - `serial_numbers` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiSerialNumberOutput[], required — Serial numbers of items fulfilled in the order, grouped by order line.
        - `line_key` string, nullable, required — Key of the order line item these serial numbers belong to; null when serial numbers cannot be matched to a specific line.
        - `serial_numbers` FulfillmentIntegrationsBundleApiResourceOutputOrderPublicApiSerialNumberItemOutput[], required — Serial numbers recorded for units fulfilled on this order line.
          - `sku` string, required — Stock Keeping Unit (SKU) identifying the product.
          - `serial_number` string, required — Serial number recorded for the fulfilled unit.
      - `gift_message` string, nullable, required — Gift message to include with the order; null if the order is not a gift.
      - `gift_from` string, nullable, required — Name of the gift sender; null if the order is not a gift.
      - `customer_notes` string, nullable, required — Customer-provided notes about the order; null if no notes were submitted.
      - `order_detail_url` string, required — URL to view the order in the ShipMonk web application (requires sign-in).

---

[API](https://skmtc.net/shipmonk/apis/shipmonk-api.md) · [All operations](https://skmtc.net/shipmonk/apis/shipmonk-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipmonk/shipmonk-api/versions/59ec2621d98d/schema)