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]

    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.

    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.

    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.

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

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      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

    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

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      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

    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