Create Parcel Order

This method is used to create draft parcel orders that can be viewed from the open orders page in the dashboard.

Endpoint

Method URI Headers
POST parcel-orders default

Request

Field | Required | Type | Description
- | : | :- | shipment_order_id | No | Integer | This field is used for updating existing shipment order. If not provided, system will generate a new one. from_address_id | No | Integer | This field is used to identify sender address. You can fetch your saved addresses from address-book. Addresses can be managed from the website on live dashboard or sandbox dashboard. Not required if a "from_address" object was used.

Note: If both "from_address_id" and "from_address" fields are defined system will prioritise the "from_address_id". return_address_id | No | Integer | This field is used to identify return address. You should use the address which is in your saved from addresses. You can fetch your saved from addresses from address-book. Addresses can be managed from the website on live dashboard or sandbox dashboard. from_address {} | No | Object | Sender address container, not required if a "from_address_id" was used +name | Yes | String | Name of the sender +attention | No | String | Attention of the sender +street_1 | Yes | String | Street line 1 +street_2 | No | String | Street line 2 +street_3 | No | String | Street line 3 +city | Yes | String | City +zip | Yes | String | Postal Zip code +state | No | String | State - This field is required for US or Canada addresses please refer to country-codes +country | Yes | String | Country (code) for the list please refer to country-codes +telephone | Yes | String | Telephone Number to_address {} | Yes | Object | Receiver address container +name | Yes | String | Name of the receiver +attention | No | String | Attention of the receiver +street_1 | Yes | String | Street line 1 +street_2 | No | String | Street line 2 +street_3 | No | String | Street line 3 +city | Yes | String | City +zip | Yes | String | Postal Zip code +state | No | String | State - This field is required for US or Canada addresses please refer to country-codes +country | Yes | String | Country (code) for the list please refer to country-codes +telephone | Yes | String | Telephone Number weight_unit | No | String | By default, weight unit is taken from your preferences. However, it can be overwritten using this field. Valid values: LBS and KG length_unit | No | String | By default, length unit is taken from your preferences. However, it can be overwritten using this field. Valid values: IN and CM package_list [] | Yes | Array | An array containing all the package information +count | Yes | Integer | Pieces count +box_type | No | String | Carrier box types for the list please refer to Parcel Box Types +length | Yes | Float | Length +width | Yes | Float | Width +height | Yes | Float | Height +weight | Yes | Float | Weight +reference_1 | No | String | Reference that will appear on the label +reference_2 | No | String | Reference that will appear on the label +insurance | No | Boolean | Default is false. Setting this to true would require items information +signature | No | Array | Default is no_signature, other options are adult_signature and signature +items [] | No | Array | An array containing all items information. Condition: only required on international shipments and shipments with insurance ++quantity | No | Integer | Quantity of the item Condition: only required when items [] is used ++price | No | Float | Price of the item Condition: only required when items [] is used ++country_of_manufacture | No | Float | Where the item is manufactured needs to be a country code please refer to country-codes. Condition: only required when items [] is used ++sku | No | String | SKU. Condition: only required when items [] is used ++hs_code | No | String | HS Tariff Code of item. The HS tariff code is an internationally standardized classification system for traded goods, used to determine tariffs and customs duties. Condition: only required when items [] is used ++description | No | String | A brief description for customs. Condition: only required when items [] is used ++content_type | No* | String | Default is Merchandise, acceptable values are Merchandise, Gift, Documents, Sample. Condition: only required when items [] is used extra_services [] | No | Array | An array containing all the extra services +saturday_delivery | No | Boolean | Default is false. +certified_mail | No | Boolean | Default is false. +return_receipt | No | Boolean | Default is false. +return_receipt_electronic | No | Boolean | Default is false. +restricted_delivery | No | Boolean | Default is false. customs_details {} | No | Object | Customs details container +bill_type | No | String | Either DDU or DDP should be selected, default is DDP. +tax_id_type | No | String | Either VAT, EIN or SSN should be used, default is null. +tax_id | No | String | Default is null. +issuer_country | No | String | Default is null. +aes_itn | No | String | Default is null.

Request Example

{
    "from_address": {
        "name": "Example Corp",
        "attention": "John Doe",
        "city": "Los Angeles",
        "street_1": "123 S Main St",
        "zip": "90012",
        "state": "CA",
        "country": "US",
        "telephone": "9999999999"
    },
    "to_address": {
        "name": "Example Corp",
        "attention": "John Doe",
        "city": "Flushing",
        "street_1": "123 Main St",
        "zip": "11354",
        "state": "NY",
        "country": "US",
        "telephone": "9999999999"
    },
    "package_list": [
        {
            "length": 5,
            "width": 4,
            "count": 3,
            "weight": 2,
            "height": 1,
            "insurance": false,
            "signature": "no_signature",
            "items": [
                {
                    "quantity": 1,
                    "price": 12.5,
                    "sku": "SKU",
                    "hs_code": "620342",
                    "description": "Fryer",
                    "content_type": "Merchandise"
                }
            ]
        }
    ]
}

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": 123123123
    },
    "message": "Parcel Order created"
}

Failed

{
    "success": false,
    "message": "The given data was invalid.",
    "data": {
        "to_address.city": [
            "The to address.city field is required."
        ]
    }
}