COcommercelayer
shipments

Create a shipment

Changed on

Create a shipment

post/shipments

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/shipments
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": {
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "shipping_category": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "inventory_stock_location": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "shipping_address": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "shipping_method": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "tags": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The created shipment object

Changes