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.
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 (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<items type="array">
<item>
<billing-address-id type="integer">42</billing-address-id>
<created-at>string</created-at>
<customer-id type="integer">42</customer-id>
<email-sent type="integer">42</email-sent>
<entity-id type="integer">42</entity-id>
<increment-id>string</increment-id>
<order-id type="integer">42</order-id>
<packages type="array">
<package>
<extension-attributes>
</extension-attributes>
</package>
</packages>
<shipment-status type="integer">42</shipment-status>
<shipping-address-id type="integer">42</shipping-address-id>
<shipping-label>string</shipping-label>
<store-id type="integer">42</store-id>
<total-qty type="float">42.0</total-qty>
<total-weight type="float">42.0</total-weight>
<updated-at>string</updated-at>
<items type="array">
<item>
<additional-data>string</additional-data>
<description>string</description>
<entity-id type="integer">42</entity-id>
<name>string</name>
<parent-id type="integer">42</parent-id>
<price type="float">42.0</price>
<product-id type="integer">42</product-id>
<row-total type="float">42.0</row-total>
<sku>string</sku>
<weight type="float">42.0</weight>
<extension-attributes>
<list-price type="float">42.0</list-price>
<size>string</size>
<color>string</color>
<merchant-product-reference>string</merchant-product-reference>
<category-code>string</category-code>
<image>string</image>
<mpn>string</mpn>
<msrp type="float">42.0</msrp>
<manufacturer-code>string</manufacturer-code>
<manufacturer-name>string</manufacturer-name>
<merchant-code>string</merchant-code>
<merchant-name>string</merchant-name>
<merchant-city>string</merchant-city>
<merchant-commission-percentage type="float">42.0</merchant-commission-percentage>
<merchant-deficiency-percentage type="float">42.0</merchant-deficiency-percentage>
<merchant-handling-fee type="float">42.0</merchant-handling-fee>
<is-sale type="boolean">true</is-sale>
<return-item-fee type="float">42.0</return-item-fee>
<base-return-item-fee type="float">42.0</base-return-item-fee>
<price-incl-tax type="float">42.0</price-incl-tax>
<base-price-incl-tax type="float">42.0</base-price-incl-tax>
<is-outlet type="boolean">true</is-outlet>
<qty-to-deduct type="integer">42</qty-to-deduct>
</extension-attributes>
<order-item-id type="integer">42</order-item-id>
<qty type="float">42.0</qty>
</item>
</items>
<tracks type="array">
<track>
<order-id type="integer">42</order-id>
<created-at>string</created-at>
<entity-id type="integer">42</entity-id>
<parent-id type="integer">42</parent-id>
<updated-at>string</updated-at>
<weight type="float">42.0</weight>
<qty type="float">42.0</qty>
<description>string</description>
<extension-attributes>
<label-filename>string</label-filename>
<status>string</status>
<insured type="boolean">true</insured>
</extension-attributes>
<track-number>string</track-number>
<title>string</title>
<carrier-code>string</carrier-code>
</track>
</tracks>
<comments type="array">
<comment>
<is-customer-notified type="integer">42</is-customer-notified>
<parent-id type="integer">42</parent-id>
<extension-attributes>
</extension-attributes>
<comment>string</comment>
<is-visible-on-front type="integer">42</is-visible-on-front>
<created-at>string</created-at>
<entity-id type="integer">42</entity-id>
</comment>
</comments>
<extension-attributes>
<source-code>string</source-code>
<customer-email>string</customer-email>
<customer-firstname>string</customer-firstname>
<customer-lastname>string</customer-lastname>
<customer-middlename>string</customer-middlename>
<status>string</status>
<delivered-at>string</delivered-at>
<collected-at>string</collected-at>
<merchant-code>string</merchant-code>
<delayed-notification-send>string</delayed-notification-send>
<packed-at>string</packed-at>
<logistics-service-provider-code>string</logistics-service-provider-code>
<external-funding>string</external-funding>
<company-id type="integer">42</company-id>
</extension-attributes>
</item>
</items>
<search-criteria>
<filter-groups type="array">
<filter-group>
<filters type="array">
<filter>
<field>string</field>
<value>string</value>
<condition-type>string</condition-type>
</filter>
</filters>
</filter-group>
</filter-groups>
<sort-orders type="array">
<sort-order>
<field>string</field>
<direction>string</direction>
</sort-order>
</sort-orders>
<page-size type="integer">42</page-size>
<current-page type="integer">42</current-page>
</search-criteria>
<total-count type="integer">42</total-count>
</root>
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 (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
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"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>