ReDoc documentation

shipment/

shipment/

post/V1/shipment/

Performs persist operations for a specified shipment.

Request
Request Body schema:
required
object (sales-data-shipment-interface)

Shipment 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.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "entity": {
    }
}
Response samples
{
  • "billing_address_id": 0,
  • "created_at": "string",
  • "customer_id": 0,
  • "email_sent": 0,
  • "entity_id": 0,
  • "increment_id": "string",
  • "order_id": 0,
  • "packages": [
    ],
  • "shipment_status": 0,
  • "shipping_address_id": 0,
  • "shipping_label": "string",
  • "store_id": 0,
  • "total_qty": 0,
  • "total_weight": 0,
  • "updated_at": "string",
  • "items": [
    ],
  • "tracks": [
    ],
  • "comments": [
    ],
  • "extension_attributes": {
    }
}
➔ Next to shipment/track