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]
Hide items attributes Show items attributes object
Input argument for shipment item creation Interface ShipmentItemCreationInterface
- 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]
Hide tracks attributes Show tracks attributes object
Shipment Track Creation interface.
- 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]
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\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

Body

items array[object]
Hide items attributes Show items attributes object
Input argument for shipment item creation Interface ShipmentItemCreationInterface
- 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]
Hide tracks attributes Show tracks attributes object
Shipment Track Creation interface.
- 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]
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\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

application/json

application/json application/xml

200 Success.

Id of created Shipment.

Id of created Shipment.
401

application/json

application/json application/xml

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

application/json

application/json application/xml

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

POST /V1/order/{orderId}/ship

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/order/{orderId}/ship' \
 --header "Content-Type: application/json" \
 --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"}}}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/order/{orderId}/ship' \
 --header "Content-Type: application/xml"

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"
    }
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <extension-attributes>
      </extension-attributes>
      <order-item-id type="integer">42</order-item-id>
      <qty type="float">42.0</qty>
    </item>
  </items>
  <notify type="boolean">true</notify>
  <appendComment type="boolean">true</appendComment>
  <comment>
    <extension-attributes>
    </extension-attributes>
    <comment>string</comment>
    <is-visible-on-front type="integer">42</is-visible-on-front>
  </comment>
  <tracks type="array">
    <track>
      <extension-attributes>
      </extension-attributes>
      <track-number>string</track-number>
      <title>string</title>
      <carrier-code>string</carrier-code>
    </track>
  </tracks>
  <packages type="array">
    <package>
      <extension-attributes>
      </extension-attributes>
    </package>
  </packages>
  <arguments>
    <extension-attributes>
      <source-code>string</source-code>
    </extension-attributes>
  </arguments>
</root>

Response examples (200)

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>