Magento2
GET /V1/shipment/{id}

Loads a specified shipment.

Path parameters

  • id integer Required

    The shipment ID.

Responses

  • 200

    200 Success.

    Hide response attributes Show response 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]

      Array of packages, if any. Otherwise, null.

      Hide packages attribute Show packages attribute 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.

      • 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

      Array of items.

      Hide items attributes Show items attributes object

      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.

      • 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

      Array of tracks.

      Hide tracks attributes Show tracks attributes object

      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.

      • 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

      Array of comments.

      Hide comments attributes Show comments attributes object

      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.

      • 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
    Hide response attributes Show response 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]

      Array of packages, if any. Otherwise, null.

      Hide packages attribute Show packages attribute 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.

      • 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

      Array of items.

      Hide items attributes Show items attributes object

      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.

      • 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

      Array of tracks.

      Hide tracks attributes Show tracks attributes object

      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.

      • 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

      Array of comments.

      Hide comments attributes Show comments attributes object

      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.

      • 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
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • 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 list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • 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 list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • 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 list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • 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 list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
GET /V1/shipment/{id} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/shipment/{id}'
Response examples (200) 
{
  "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
  }
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <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>
</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>