Shipments

sales Shipment Repository V1Get List Get

get

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://devdocs.magento.com/codelinks/attributes.html#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]stringOptional

Field

Example: <string>

searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>

searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>

searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>

searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>

searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>

searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /V1/shipments HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "order_id": "<integer>",
      "items": [
        {
          "order_item_id": "<integer>",
          "qty": "<number>",
          "additional_data": "<string>",
          "description": "<string>",
          "entity_id": "<integer>",
          "name": "<string>",
          "parent_id": "<integer>",
          "price": "<number>",
          "product_id": "<integer>",
          "row_total": "<number>",
          "sku": "<string>",
          "weight": "<number>",
          "extension_attributes": "<object>"
        },
        {
          "order_item_id": "<integer>",
          "qty": "<number>",
          "additional_data": "<string>",
          "description": "<string>",
          "entity_id": "<integer>",
          "name": "<string>",
          "parent_id": "<integer>",
          "price": "<number>",
          "product_id": "<integer>",
          "row_total": "<number>",
          "sku": "<string>",
          "weight": "<number>",
          "extension_attributes": "<object>"
        }
      ],
      "tracks": [
        {
          "order_id": "<integer>",
          "parent_id": "<integer>",
          "weight": "<number>",
          "qty": "<number>",
          "description": "<string>",
          "track_number": "<string>",
          "title": "<string>",
          "carrier_code": "<string>",
          "created_at": "<string>",
          "entity_id": "<integer>",
          "updated_at": "<string>",
          "extension_attributes": "<object>"
        },
        {
          "order_id": "<integer>",
          "parent_id": "<integer>",
          "weight": "<number>",
          "qty": "<number>",
          "description": "<string>",
          "track_number": "<string>",
          "title": "<string>",
          "carrier_code": "<string>",
          "created_at": "<string>",
          "entity_id": "<integer>",
          "updated_at": "<string>",
          "extension_attributes": "<object>"
        }
      ],
      "comments": [
        {
          "is_customer_notified": "<integer>",
          "parent_id": "<integer>",
          "comment": "<string>",
          "is_visible_on_front": "<integer>",
          "extension_attributes": "<object>",
          "created_at": "<string>",
          "entity_id": "<integer>"
        },
        {
          "is_customer_notified": "<integer>",
          "parent_id": "<integer>",
          "comment": "<string>",
          "is_visible_on_front": "<integer>",
          "extension_attributes": "<object>",
          "created_at": "<string>",
          "entity_id": "<integer>"
        }
      ],
      "billing_address_id": "<integer>",
      "created_at": "<string>",
      "customer_id": "<integer>",
      "email_sent": "<integer>",
      "entity_id": "<integer>",
      "increment_id": "<string>",
      "packages": [
        {
          "extension_attributes": "<object>"
        },
        {
          "extension_attributes": "<object>"
        }
      ],
      "shipment_status": "<integer>",
      "shipping_address_id": "<integer>",
      "shipping_label": "<string>",
      "store_id": "<integer>",
      "total_qty": "<number>",
      "total_weight": "<number>",
      "updated_at": "<string>",
      "extension_attributes": {
        "source_code": "<string>"
      }
    },
    {
      "order_id": "<integer>",
      "items": [
        {
          "order_item_id": "<integer>",
          "qty": "<number>",
          "additional_data": "<string>",
          "description": "<string>",
          "entity_id": "<integer>",
          "name": "<string>",
          "parent_id": "<integer>",
          "price": "<number>",
          "product_id": "<integer>",
          "row_total": "<number>",
          "sku": "<string>",
          "weight": "<number>",
          "extension_attributes": "<object>"
        },
        {
          "order_item_id": "<integer>",
          "qty": "<number>",
          "additional_data": "<string>",
          "description": "<string>",
          "entity_id": "<integer>",
          "name": "<string>",
          "parent_id": "<integer>",
          "price": "<number>",
          "product_id": "<integer>",
          "row_total": "<number>",
          "sku": "<string>",
          "weight": "<number>",
          "extension_attributes": "<object>"
        }
      ],
      "tracks": [
        {
          "order_id": "<integer>",
          "parent_id": "<integer>",
          "weight": "<number>",
          "qty": "<number>",
          "description": "<string>",
          "track_number": "<string>",
          "title": "<string>",
          "carrier_code": "<string>",
          "created_at": "<string>",
          "entity_id": "<integer>",
          "updated_at": "<string>",
          "extension_attributes": "<object>"
        },
        {
          "order_id": "<integer>",
          "parent_id": "<integer>",
          "weight": "<number>",
          "qty": "<number>",
          "description": "<string>",
          "track_number": "<string>",
          "title": "<string>",
          "carrier_code": "<string>",
          "created_at": "<string>",
          "entity_id": "<integer>",
          "updated_at": "<string>",
          "extension_attributes": "<object>"
        }
      ],
      "comments": [
        {
          "is_customer_notified": "<integer>",
          "parent_id": "<integer>",
          "comment": "<string>",
          "is_visible_on_front": "<integer>",
          "extension_attributes": "<object>",
          "created_at": "<string>",
          "entity_id": "<integer>"
        },
        {
          "is_customer_notified": "<integer>",
          "parent_id": "<integer>",
          "comment": "<string>",
          "is_visible_on_front": "<integer>",
          "extension_attributes": "<object>",
          "created_at": "<string>",
          "entity_id": "<integer>"
        }
      ],
      "billing_address_id": "<integer>",
      "created_at": "<string>",
      "customer_id": "<integer>",
      "email_sent": "<integer>",
      "entity_id": "<integer>",
      "increment_id": "<string>",
      "packages": [
        {
          "extension_attributes": "<object>"
        },
        {
          "extension_attributes": "<object>"
        }
      ],
      "shipment_status": "<integer>",
      "shipping_address_id": "<integer>",
      "shipping_label": "<string>",
      "store_id": "<integer>",
      "total_qty": "<number>",
      "total_weight": "<number>",
      "updated_at": "<string>",
      "extension_attributes": {
        "source_code": "<string>"
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "officia cupidatat sed",
            "value": "sunt con",
            "condition_type": "et voluptat"
          },
          {
            "field": "eiusmod Lorem",
            "value": "sit ipsum anim sunt",
            "condition_type": "quis"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "pariatur fugiat",
            "value": "sed cupidatat",
            "condition_type": "adipisicing sint velit cillum"
          },
          {
            "field": "do consequat",
            "value": "amet D",
            "condition_type": "in non est"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "anim deserunt est",
        "direction": "qui proident ipsum elit"
      },
      {
        "field": "ea amet dolore",
        "direction": "cupidatat exercitation in Lorem dolore"
      }
    ],
    "page_size": 86060223,
    "current_page": 23075430
  },
  "total_count": 78684841
}