COcommercelayer
parcels

Create a parcel

Changed on

Create a parcel

post/parcels

Request

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

Request body

Example request

{
  "data": {
    "attributes": {
      "weight": 1000,
      "unit_of_weight": "gr",
      "eel_pfc": "EEL",
      "contents_type": "merchandise",
      "customs_signer": "John Doe",
      "non_delivery_option": "return",
      "restriction_type": "none",
      "shipping_label_url": "https://bucket.s3-us-west-2.amazonaws.com/files/postage_label/20180101/123.pdf",
      "shipping_label_file_type": "application/pdf",
      "shipping_label_size": "4x7",
      "shipping_label_resolution": "200",
      "tracking_number": "1Z4V2A000000000000",
      "tracking_status": "delivered",
      "tracking_status_detail": "arrived_at_destination",
      "tracking_status_updated_at": "2018-01-01T12:00:00.000Z",
      "tracking_details": [
        {
          "object": "TrackingDetail",
          "message": "Pre-Shipment information received",
          "status": "pre_transit",
          "datetime": "2018-02-27T16:02:17Z",
          "source": "DHLExpress",
          "tracking_location": {
            "object": "TrackingLocation"
          }
        }
      ],
      "carrier_weight_oz": "42.32",
      "signed_by": "John Smith",
      "incoterm": "EXW",
      "delivery_confirmation": "SIGNATURE",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "shipment": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "package": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The created parcel object

Changes

  • 859097ed3fe6Revision changes
    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      request property // was restricted to a list of enum values

    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • breaking

      the // request property type changed from string to array

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property default value parcels was removed

    • info

      added the new gr enum value to the request property //

    • info

      added the new lb enum value to the request property //

    • info

      added the new oz enum value to the request property //

    • info

      added the new parcels enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status