# ST11 - List shipments

Call FrequencyRecommended usage: at each shipment page displayMaximum usage: at each shipment page displayRead MoreMore contextPaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have the following values:dateCreated (Default) - Sort by creation date (asc by default)

Endpoint: GET /api/shipments

## Query parameters:

  - `order_id` (array)
    Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).

  - `shipment_state_code` (array)
    Shipment state code for filtering. This parameter can be supplied multiple times (shipment_state_code=SHIPPING&shipment_state_code=SHIPPED...).

  - `shipment_customer_debit_state_code` (array)
    Shipment customer debit state code for filtering. This parameter can be supplied multiple times (shipment_customer_debit_state_code=WAITING_TAX_CONFIRMATION&shipment_customer_debit_state_code=DEBIT_OK...).

  - `last_updated_from` (string)
    Filter shipments updated after the given date.

  - `last_updated_to` (string)
    Filter shipments updated before the given date.

## Response 200 fields (application/json):

  - `data` (array, required)
    Page of data

  - `data.created_date` (string, required)
    Shipment's creation date

  - `data.id` (string, required)
    Shipment id

  - `data.invoice_reference` (string)
    Shipment's invoice reference

  - `data.last_updated_date` (string, required)
    Shipment's last updated date

  - `data.order_id` (string, required)
    Order id

  - `data.payment_details` (object)
    Shipment's payment details

  - `data.payment_details.customer_debited_date` (string, required)
    Payment's date of the shipment by the customer

  - `data.payment_details.transaction_date` (string, required)
    Payment transaction date

  - `data.payment_details.transaction_number` (string)
    Payment transaction number

  - `data.shipment_additional_information` (array)
    Shipment's additional information

  - `data.shipment_additional_information.code` (string)
    Shipment's additional information code

  - `data.shipment_additional_information.type` (string)
    Shipment's additional information type
    Enum: "STRING", "DATE"

  - `data.shipment_lines` (array)
    Shipment lines

  - `data.shipment_lines.offer_sku` (string)
    Offer sku

  - `data.shipment_lines.order_line_id` (string)
    Order line id

  - `data.shipment_lines.package_reference` (string)
    Package reference

  - `data.shipment_lines.quantity` (integer, required)
    Quantity

  - `data.shipped_date` (string)
    Shipment's shipped date.

  - `data.shipping_from` (object)
    Shipment's shipping origin

  - `data.shipping_from.address` (object)
    Shipping origin address

  - `data.shipping_from.address.city` (string)
    City

  - `data.shipping_from.address.country_iso_code` (string)
    Country ISO code

  - `data.shipping_from.address.state` (string)
    State

  - `data.shipping_from.address.street_1` (string)
    First information line of the address street

  - `data.shipping_from.address.street_2` (string)
    Second information line of the address street

  - `data.shipping_from.address.zip_code` (string)
    Address zip code

  - `data.shipping_from.warehouse` (object)
    Shipping origin warehouse

  - `data.shipping_from.warehouse.code` (string)
    Warehouse's code

  - `data.status` (string, required)
    Shipment status
    Enum: "SHIPPING", "READY_FOR_PICK_UP", "SHIPMENT_PREPARED", "SHIPPED", "TO_COLLECT", "RECEIVED", "CANCELED", "CLOSED"

  - `data.status_customer_debit` (string, required)
    Shipment debit status
    Enum: "NO_DEBIT", "NOT_STARTED", "WAITING_TAX_CONFIRMATION", "WAITING_OPERATOR_SYSTEM_CONTACT", "WAITING_DEBIT_CONFIRMATION", "DEBIT_OK", "CANCELED"

  - `data.tracking` (object)
    Shipment tracking details

  - `data.tracking.carrier_code` (string)
    The code of a carrier. This information is mandatory for a registered carrier.

  - `data.tracking.carrier_name` (string)
    The name of a carrier. This information is mandatory for an unregistered carrier.

  - `data.tracking.carrier_standard_code` (string)
    The standard code of a carrier based on mirakl carrier referential

  - `data.tracking.last_known_location` (object)
    The last location known and transmitted by carriers

  - `data.tracking.last_known_location.location` (string)
    Last known location of the shipment

  - `data.tracking.last_known_location.occurrence_date` (object)
    Occurrence date of the known location

  - `data.tracking.last_known_location.occurrence_date.date` (string)
    Date

  - `data.tracking.last_known_location.occurrence_date.offset` (string)
    Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset).

  - `data.tracking.last_known_location.occurrence_date.time` (string)
    Time, with the following format (compliant with ISO8601) : hh:mm[:ss]

  - `data.tracking.milestones` (array)
    Retrieves the main stages of the delivery of a shipment coming from carrier's systems

  - `data.tracking.milestones.additional_info` (object)
    Additional information about the current milestone

  - `data.tracking.milestones.additional_info.occurrence_date` (object)
    Occurrence date

  - `data.tracking.milestones.additional_info.type` (string)
    Type of the additional information
    Enum: "DESTINATION_ARRIVAL", "DATA_ORDER_CANCELLED", "DATA_DELIVERY_PROPOSED", "DATA_DELIVERY_DECIDED", "CUSTOMS_RECEIVED", "CUSTOMS_EXCEPTION", "CUSTOMS_CLEARED", "CUSTOMS_REJECTED", "DELIVERY_ATTEMPTED", "DELIVERY_EXCEPTION"

  - `data.tracking.milestones.type` (string)
    Type of milestone
    Enum: "IN_TRANSIT", "OUT_FOR_DELIVERY", "TO_COLLECT", "DELIVERED", "EXCEPTION"

  - `data.tracking.tracking_number` (string)
    The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number.

  - `data.tracking.tracking_url` (string)
    The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.

  - `data.tracking.validity_status` (string)
    Retrieves if mirakl is able to get tracking information (if not, then unverified) and if we manage to get tracking information and if we do get tracking information on this tracking, then it moves to verified, if we don't it remains in unverified
    Enum: "MISSING_TRACKING", "UNVERIFIED", "UNCOVERED", "INVALID", "VERIFIED"

  - `next_page_token` (string)
    Token to access the next page. Absent if the current page is the last one.

  - `previous_page_token` (string)
    Token to access the previous page. Absent if the current page is the first one.