Create a package

How to create a package via API

To create a new package, send a POST request to the /api/packages endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/packages

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.code	string	Optional
attributes.length	float	Required
attributes.width	float	Required
attributes.height	float	Required
attributes.unit_of_length	string	Required
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.stock_location	object	Required

Example

Request

The following request creates a new package:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/packages' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "packages",
    "attributes": {
      "name": "Large (60x40x30)",
      "length": 40.0,
      "width": 40.0,
      "height": 25.0,
      "unit_of_length": "gr"
    },
    "relationships": {
      "stock_location": {
        "data": {
          "type": "stock_locations",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response