sales Shipment Repository V1Save Post
POST {{baseUrl}}/V1/shipment/
Performs persist operations for a specified shipment.
Request Body
{"entity"=>{"order_id"=>"<integer>", "items"=>[{"order_item_id"=>"<integer>", "qty"=>"<number>", "additional_data"=>"<string>", "description"=>"<string>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>", "name"=>"<string>", "parent_id"=>"<integer>", "price"=>"<number>", "product_id"=>"<integer>", "row_total"=>"<number>", "sku"=>"<string>", "weight"=>"<number>"}, {"order_item_id"=>"<integer>", "qty"=>"<number>", "additional_data"=>"<string>", "description"=>"<string>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>", "name"=>"<string>", "parent_id"=>"<integer>", "price"=>"<number>", "product_id"=>"<integer>", "row_total"=>"<number>", "sku"=>"<string>", "weight"=>"<number>"}], "tracks"=>[{"order_id"=>"<integer>", "parent_id"=>"<integer>", "weight"=>"<number>", "qty"=>"<number>", "description"=>"<string>", "track_number"=>"<string>", "title"=>"<string>", "carrier_code"=>"<string>", "created_at"=>"<string>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>", "updated_at"=>"<string>"}, {"order_id"=>"<integer>", "parent_id"=>"<integer>", "weight"=>"<number>", "qty"=>"<number>", "description"=>"<string>", "track_number"=>"<string>", "title"=>"<string>", "carrier_code"=>"<string>", "created_at"=>"<string>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>", "updated_at"=>"<string>"}], "comments"=>[{"is_customer_notified"=>"<integer>", "parent_id"=>"<integer>", "comment"=>"<string>", "is_visible_on_front"=>"<integer>", "created_at"=>"<string>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>"}, {"is_customer_notified"=>"<integer>", "parent_id"=>"<integer>", "comment"=>"<string>", "is_visible_on_front"=>"<integer>", "created_at"=>"<string>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>"}], "billing_address_id"=>"<integer>", "created_at"=>"<string>", "customer_id"=>"<integer>", "email_sent"=>"<integer>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>", "increment_id"=>"<string>", "packages"=>[{"extension_attributes"=>"<object>"}, {"extension_attributes"=>"<object>"}], "shipment_status"=>"<integer>", "shipping_address_id"=>"<integer>", "shipping_label"=>"<string>", "store_id"=>"<integer>", "total_qty"=>"<number>", "total_weight"=>"<number>", "updated_at"=>"<string>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
""