What parameters does POST /V1/shipment/ accept?

This endpoint accepts 1 parameter: entity (Magento\Sales\Api\Data\ShipmentInterface) required.

What does POST /V1/shipment/ return?

The endpoint returns Magento\Sales\Api\Data\ShipmentInterface.

POSTSales · Magento 2.4.9 Admin · Magento_Sales::shipment

POST /V1/shipment/

Q: What does the POST /V1/shipment/ endpoint do in Magento 2?

POST /V1/shipment/ is a Magento 2 REST endpoint in the Sales module. Performs persist operations for a specified shipment. Requires an admin Bearer token with ACL Magento_Sales::shipment.

Q: Does POST /V1/shipment/ require authentication?

This endpoint requires an admin Bearer token with ACL: Magento_Sales::shipment.

POST /V1/shipment/ is a Magento 2 REST endpoint in the Sales module. Performs persist operations for a specified shipment. Requires an admin Bearer token with ACL Magento_Sales::shipment.

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

Magento\Sales\Api\Data\ShipmentInterface

Shipment interface.

Service contract

Magento\Sales\Api\ShipmentRepositoryInterface::save

Authorization

Admin Bearer token with ACL:

Magento_Sales::shipment

Body parameters

entity Magento\Sales\Api\Data\ShipmentInterface Required

The shipment.

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

application/json

Content-Type

application/json

Authorization

Bearer <ACCESS_TOKEN> admin token with ACL: Magento_Sales::shipment

Path

/V1/shipment/

Body

{
  "entity": {
    "billing_address_id": 0,
    "comments": [
      {
        "comment": "",
        "created_at": "",
        "entity_id": 0,
        "extension_attributes": {},
        "is_customer_notified": 0,
        "is_visible_on_front": 0,
        "parent_id": 0
      }
    ],
    "created_at": "",
    "customer_id": 0,
    "email_sent": 0,
    "entity_id": 0,
    "extension_attributes": {},
    "increment_id": "",
    "items": [
      {
        "additional_data": "",
        "description": "",
        "entity_id": 0,
        "extension_attributes": {},
        "name": "",
        "order_item_id": 0,
        "parent_id": 0,
        "price": 0,
        "product_id": 0,
        "qty": 0,
        "row_total": 0,
        "sku": "",
        "weight": 0
      }
    ],
    "order_id": 0,
    "packages": [
      {
        "extension_attributes": {}
      }
    ],
    "shipment_status": 0,
    "shipping_address_id": 0,
    "shipping_label": "",
    "store_id": 0,
    "total_qty": 0,
    "total_weight": 0,
    "tracks": [
      {
        "carrier_code": "",
        "created_at": "",
        "description": "",
        "entity_id": 0,
        "extension_attributes": {},
        "order_id": 0,
        "parent_id": 0,
        "qty": 0,
        "title": "",
        "track_number": "",
        "updated_at": "",
        "weight": 0
      }
    ],
    "updated_at": ""
  }
}