Send Parcel

This request will send the parcel order results (including label and tracking numbers) upon completion to the webhook endpoint attached to the used token. The results will be sent to the webhook endpoint 4 times with 5 minute intervals just in case if the first time was not successful.

Please note that this endpoint has rate-limiting, therefore, it will only allow 1000 requests per minute.

Endpoint

Method URI Headers
POST parcel-orders/ship default

Request

Field | Required | Type | Description
- | : | :- | rate_id | Yes | Integer | This field is used to identify the selected rate. You can retrieve this from the get-rates response

Request Example

{
    "rate_id": 12345678
}

Response

Field | Type | Description
- | : | success | Boolean | true or false message | String | Message data | Object | Shipment order id container +shipment_order_id | Integer | This is the id of your shipment

Response Examples

Successful

{
    "success": true,
    "data": {
        "shipment_order_id": 863100211
    },
    "message": "Operation successful! We will send the shipment details to your webhook address as soon as it is ready"
}

Failed

{
    "success": false,
    "message": "The given data was invalid."
}

Webhook Body

Field | Type | Description
- | : | shipment_order_id | Integer | Related Shipment Order main_tracking_number | String | Main tracking number sub_tracking_numbers | Array | An array containing tracking numbers package_details [] | Array | An array containing all the package information +tracking_number | String | Tracking number of the specific package +items [] | Array | An array of the package items ++sku | String | SKU of the specific package item ++quantity | String | Quantity of the specific package item ++price | String | Price of the specific package item final_price | Float | Final price carrier | String | Carrier label | String | Label Url customs_form | String | Customs form Url (only when the shipment is international)

Webhook Body Example

{
    "shipment_order_id": 123123123,
    "main_tracking_number": "1Z47D7YDHBEG123",
    "sub_tracking_numbers": ["1Z47D7YDHBEG123", "1Z47D7YDHBEG124"],
    "package_details": [
        {
            "tracking_number": "1Z5RR1050313482583",
            "items": [
                {
                    "sku": "SKU1",
                    "quantity": "1",
                    "price": "1.00"
                },
                {
                    "sku": "SKU2",
                    "quantity": "2",
                    "price": "2.00"
                }
            ]
        }
    ],
    "final_price": "11.11",
    "carrier": "ups",
    "service": "UPS® Ground",
    "label": "/label/url/12355",
    "customs_form": "/customs/url/123123"
}