Creates new Shipment for given Order
Creates new Shipment for given Order.
Body
-
items array[object]
Input argument for shipment item creation Interface ShipmentItemCreationInterface
-
notify boolean
-
appendComment boolean
-
comment object
Interface ShipmentCommentCreationInterface
-
tracks array[object]
Shipment Track Creation interface.
-
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.
-
arguments object
Interface for creation arguments for Shipment.
POST /V1/order/{orderId}/ship
curl \
-X POST https://magento2.winkelstraat.mac/rest/all/V1/order/{orderId}/ship \
-d '{"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"
}