Create a Shipment

Create a Partial or Full Shipment

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Arguments

string

***required*** Carrier code.

string

A comment for this shipment.

object

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

array

The items in this shipment.

stringrequired

The unique id of the order to be shipped.

number

string

The source code for this shipment. i.e. 'ne_wh' to ship from the NorthEast Warehouse.

stringrequired

boolean

True/False whether to notify the customer about this shipment.

string

stringrequired

string

Tracking Number for the shipment.

boolean

is_visible_on_front flag value. (1:True or 0:False)

boolean

string

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

object

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

string

***required*** (string) Title.

object

array of object

Array of objects (sales-data-shipment-track-creation-interface)

array

Array of objects (sales-data-shipment-package-creation-interface)

object

Interface for creation arguments for Shipment.