Create a parcel

How to create a parcel via API

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

Request

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

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.weight	float	Required
attributes.unit_of_weight	string	Required
attributes.eel_pfc	string	Optional
attributes.contents_type	string	Optional
attributes.contents_explanation	string	Optional
attributes.customs_certify	boolean	Optional
attributes.customs_signer	string	Optional
attributes.non_delivery_option	string	Optional
attributes.restriction_type	string	Optional
attributes.restriction_comments	string	Optional
attributes.customs_info_required	boolean	Optional, default 'false'
attributes.shipping_label_url	string	Optional
attributes.shipping_label_file_type	string	Optional
attributes.shipping_label_size	string	Optional
attributes.shipping_label_resolution	string	Optional
attributes.tracking_number	string	Optional
attributes.tracking_status	string	Optional
attributes.tracking_status_detail	string	Optional
attributes.tracking_status_updated_at	datetime	Optional
attributes.tracking_details	array	Optional
attributes.carrier_weight_oz	string	Optional
attributes.signed_by	string	Optional
attributes.incoterm	string	Optional
attributes.delivery_confirmation	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.shipment	object	Required
relationships.package	object	Required

Example

Request

The following request creates a new parcel:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/parcels' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "parcels",
    "attributes": {
      "weight": 1000.0,
      "unit_of_weight": "gr"
    },
    "relationships": {
      "shipment": {
        "data": {
          "type": "shipments",
          "id": "ABCRtyUpBa"
        }
      },
      "package": {
        "data": {
          "type": "packages",
          "id": "BCDRtyUpBa"
        }
      }
    }
  }
}'

Response