Magento2

Creates new Shipment for given Order

POST /V1/order/{orderId}/ship

Creates new Shipment for given Order.

Path parameters

  • orderId integer Required

Body

  • items array[object]

    Input argument for shipment item creation Interface ShipmentItemCreationInterface

    Input argument for shipment item creation Interface ShipmentItemCreationInterface

    Hide items attributes Show items attributes object
    • extension_attributes object

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

    • order_item_id integer Required

      Order item ID.

    • qty number Required

      Quantity.

  • notify boolean
  • appendComment boolean
  • comment object

    Interface ShipmentCommentCreationInterface

    Hide comment attributes Show comment attributes object
    • extension_attributes object

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

    • comment string Required

      Comment.

    • is_visible_on_front integer Required

      Is-visible-on-storefront flag value.

  • tracks array[object]

    Shipment Track Creation interface.

    Shipment Track Creation interface.

    Hide tracks attributes Show tracks attributes object
    • extension_attributes object

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

    • track_number string Required

      Track number.

    • title string Required

      Title.

    • carrier_code string Required

      Carrier code.

  • 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\ShipmentPackageCreationInterface

  • arguments object

    Interface for creation arguments for Shipment.

    Hide arguments attribute Show arguments attribute object
    • extension_attributes object

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

      Hide extension_attributes attribute Show extension_attributes attribute object
      • source_code string

Responses

  • 200

    200 Success.

    Id of created Shipment.
  • 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
POST /V1/order/{orderId}/ship 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/order/{orderId}/ship' \
 --data '{"items":[{"extension_attributes":{},"order_item_id":42,"qty":42.0}],"notify":true,"appendComment":true,"comment":{"extension_attributes":{},"comment":"string","is_visible_on_front":42},"tracks":[{"extension_attributes":{},"track_number":"string","title":"string","carrier_code":"string"}],"packages":[{"extension_attributes":{}}],"arguments":{"extension_attributes":{"source_code":"string"}}}'
Request examples 
{
  "items": [
    {
      "extension_attributes": {},
      "order_item_id": 42,
      "qty": 42.0
    }
  ],
  "notify": true,
  "appendComment": true,
  "comment": {
    "extension_attributes": {},
    "comment": "string",
    "is_visible_on_front": 42
  },
  "tracks": [
    {
      "extension_attributes": {},
      "track_number": "string",
      "title": "string",
      "carrier_code": "string"
    }
  ],
  "packages": [
    {
      "extension_attributes": {}
    }
  ],
  "arguments": {
    "extension_attributes": {
      "source_code": "string"
    }
  }
}
Response examples (200) 
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"
}