Lists shipments that match specified search criteria

GET /V1/shipments

Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Query parameters

  • searchCriteria[filterGroups][0][filters][0][field] string

    Field

  • searchCriteria[filterGroups][0][filters][0][value] string

    Value

  • searchCriteria[filterGroups][0][filters][0][conditionType] string

    Condition type

  • searchCriteria[sortOrders][0][field] string

    Sorting field.

  • searchCriteria[sortOrders][0][direction] string

    Sorting direction.

  • searchCriteria[pageSize] integer

    Page size.

  • searchCriteria[currentPage] integer

    Current page.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • items array[object] Required

      Shipment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

      Shipment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

      Hide items attributes Show items attributes object
      • billing_address_id integer

        Billing address ID.

      • created_at string

        Created-at timestamp.

      • customer_id integer

        Customer ID.

      • email_sent integer

        Email-sent flag value.

      • entity_id integer

        Shipment ID.

      • increment_id string

        Increment ID.

      • order_id integer Required

        Order ID.

      • packages array[object]

        Shipment package interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

        Shipment package interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

        Hide packages attribute Show packages attribute object
        • extension_attributes object

          ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentPackageInterface

      • shipment_status integer

        Shipment status.

      • shipping_address_id integer

        Shipping address ID.

      • shipping_label string

        Shipping label.

      • store_id integer

        Store ID.

      • total_qty number

        Total quantity.

      • total_weight number

        Total weight.

      • updated_at string

        Updated-at timestamp.

      • items array[object] Required

        Shipment item interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A product is an item in a shipment.

        Shipment item interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A product is an item in a shipment.

        Hide items attributes Show items attributes object
        • additional_data string

          Additional data.

        • description string

          Description.

        • entity_id integer

          Shipment item ID.

        • name string

          Name.

        • parent_id integer

          Parent ID.

        • price number

          Price.

        • product_id integer

          Product ID.

        • row_total number

          Row total.

        • sku string

          SKU.

        • weight number

          Weight.

        • extension_attributes object

          ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentItemInterface

          Hide extension_attributes attributes Show extension_attributes attributes object
          • list_price number
          • size string
          • color string
          • merchant_product_reference string
          • category_code string
          • image string
          • mpn string
          • msrp number
          • manufacturer_code string
          • manufacturer_name string
          • merchant_code string
          • merchant_name string
          • merchant_city string
          • merchant_commission_percentage number
          • merchant_deficiency_percentage number
          • merchant_handling_fee number
          • is_sale boolean
          • return_item_fee number
          • base_return_item_fee number
          • price_incl_tax number
          • base_price_incl_tax number
          • is_outlet boolean
          • qty_to_deduct integer
        • order_item_id integer Required

          Order item ID.

        • qty number Required

          Quantity.

      • tracks array[object] Required

        Shipment track interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. Merchants and customers can track shipments.

        Shipment track interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. Merchants and customers can track shipments.

        Hide tracks attributes Show tracks attributes object
        • order_id integer Required

          The order_id for the shipment package.

        • created_at string

          Created-at timestamp.

        • entity_id integer

          Shipment package ID.

        • parent_id integer Required

          Parent ID.

        • updated_at string

          Updated-at timestamp.

        • weight number Required

          Weight.

        • qty number Required

          Quantity.

        • description string Required

          Description.

        • extension_attributes object

          ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface

          Hide extension_attributes attributes Show extension_attributes attributes object
          • label_filename string
          • status string
          • insured boolean
        • track_number string Required

          Track number.

        • title string Required

          Title.

        • carrier_code string Required

          Carrier code.

      • comments array[object] Required

        Shipment comment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A shipment document can contain comments.

        Shipment comment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A shipment document can contain comments.

        Hide comments attributes Show comments attributes object
        • is_customer_notified integer Required

          Is-customer-notified flag value.

        • parent_id integer Required

          Parent ID.

        • extension_attributes object

          ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentInterface

        • comment string Required

          Comment.

        • is_visible_on_front integer Required

          Is-visible-on-storefront flag value.

        • created_at string

          Created-at timestamp.

        • entity_id integer

          Invoice ID.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentInterface

        Hide extension_attributes attributes Show extension_attributes attributes object
        • source_code string
        • customer_email string
        • customer_firstname string
        • customer_lastname string
        • customer_middlename string
        • status string
        • delivered_at string
        • collected_at string
        • merchant_code string
        • delayed_notification_send string
        • packed_at string
        • logistics_service_provider_code string
        • external_funding string
        • company_id integer
    • search_criteria object Required

      Search criteria interface.

      Hide search_criteria attributes Show search_criteria attributes object
      • filter_groups array[object] Required

        Groups two or more filters together using a logical OR

        Groups two or more filters together using a logical OR

        Hide filter_groups attribute Show filter_groups attribute object
        • filters array[object]

          Filter which can be used by any methods from service layer.

          Filter which can be used by any methods from service layer.

          Hide filters attributes Show filters attributes object
          • field string Required

            Field

          • value string Required

            Value

          • condition_type string

            Condition type

      • sort_orders array[object]

        Data object for sort order.

        Data object for sort order.

        Hide sort_orders attributes Show sort_orders attributes object
        • field string Required

          Sorting field.

        • direction string Required

          Sorting direction.

      • page_size integer

        Page size.

      • current_page integer

        Current page.

    • total_count integer Required

      Total count.

  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/shipments
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/shipments'
Response examples (200)
{
  "items": [
    {
      "billing_address_id": 42,
      "created_at": "string",
      "customer_id": 42,
      "email_sent": 42,
      "entity_id": 42,
      "increment_id": "string",
      "order_id": 42,
      "packages": [
        {
          "extension_attributes": {}
        }
      ],
      "shipment_status": 42,
      "shipping_address_id": 42,
      "shipping_label": "string",
      "store_id": 42,
      "total_qty": 42.0,
      "total_weight": 42.0,
      "updated_at": "string",
      "items": [
        {
          "additional_data": "string",
          "description": "string",
          "entity_id": 42,
          "name": "string",
          "parent_id": 42,
          "price": 42.0,
          "product_id": 42,
          "row_total": 42.0,
          "sku": "string",
          "weight": 42.0,
          "extension_attributes": {
            "list_price": 42.0,
            "size": "string",
            "color": "string",
            "merchant_product_reference": "string",
            "category_code": "string",
            "image": "string",
            "mpn": "string",
            "msrp": 42.0,
            "manufacturer_code": "string",
            "manufacturer_name": "string",
            "merchant_code": "string",
            "merchant_name": "string",
            "merchant_city": "string",
            "merchant_commission_percentage": 42.0,
            "merchant_deficiency_percentage": 42.0,
            "merchant_handling_fee": 42.0,
            "is_sale": true,
            "return_item_fee": 42.0,
            "base_return_item_fee": 42.0,
            "price_incl_tax": 42.0,
            "base_price_incl_tax": 42.0,
            "is_outlet": true,
            "qty_to_deduct": 42
          },
          "order_item_id": 42,
          "qty": 42.0
        }
      ],
      "tracks": [
        {
          "order_id": 42,
          "created_at": "string",
          "entity_id": 42,
          "parent_id": 42,
          "updated_at": "string",
          "weight": 42.0,
          "qty": 42.0,
          "description": "string",
          "extension_attributes": {
            "label_filename": "string",
            "status": "string",
            "insured": true
          },
          "track_number": "string",
          "title": "string",
          "carrier_code": "string"
        }
      ],
      "comments": [
        {
          "is_customer_notified": 42,
          "parent_id": 42,
          "extension_attributes": {},
          "comment": "string",
          "is_visible_on_front": 42,
          "created_at": "string",
          "entity_id": 42
        }
      ],
      "extension_attributes": {
        "source_code": "string",
        "customer_email": "string",
        "customer_firstname": "string",
        "customer_lastname": "string",
        "customer_middlename": "string",
        "status": "string",
        "delivered_at": "string",
        "collected_at": "string",
        "merchant_code": "string",
        "delayed_notification_send": "string",
        "packed_at": "string",
        "logistics_service_provider_code": "string",
        "external_funding": "string",
        "company_id": 42
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}
Response examples (401)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}