Create a shipment

POST 
/v1/shipments

Create a new shipment instance.

Request

application/json

Body

required

recipient

object

required

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

shipper

object

required

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

return_address

object

nullable

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

billing_address

object

nullable

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

parcels

object[]

required

The shipment's parcels

Array [

weight doublerequired

The parcel's weight

width doublenullable

The parcel's width

height doublenullable

The parcel's height

length doublenullable

The parcel's length

packaging_type stringnullable

Possible values: <= 50 characters

The parcel's packaging type.
Note that the packaging is optional when using a package preset.
values:
envelope pak tube pallet small_box medium_box your_packaging
For carrier specific packaging types, please consult the reference.

package_preset stringnullable

Possible values: <= 50 characters

The parcel's package preset.
For carrier specific package presets, please consult the reference.

description stringnullable

Possible values: <= 250 characters

The parcel's description

content stringnullable

Possible values: <= 100 characters

The parcel's content description

is_document booleannullable

Indicates if the parcel is composed of documents only

weight_unit stringrequired

Possible values: [KG, LB, OZ, G]

The parcel's weight unit

dimension_unit stringnullable

Possible values: [CM, IN, null]

The parcel's dimension unit

items

object[]

The parcel items.

Array [

weight doublerequired

The commodity's weight

weight_unit stringrequired

Possible values: [KG, LB, OZ, G]

The commodity's weight unit

title stringnullable

Possible values: <= 35 characters

A description of the commodity

description stringnullable

Possible values: <= 100 characters

A description of the commodity

quantity integer

Default value: 1

The commodity's quantity (number or item)

sku stringnullable

Possible values: <= 35 characters

The commodity's sku number

hs_code stringnullable

Possible values: <= 35 characters

The commodity's hs_code number

value_amount doublenullable

The monetary value of the commodity

value_currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, null]

The currency of the commodity value amount

origin_country stringnullable

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX, null]

The origin or manufacture country

parent_id stringnullable

The id of the related order line item.

metadata

object

nullable

Commodity user references metadata.

{ "part_number": "5218487281", "reference1": "# ref 1", "reference2": "# ref 2", "reference3": "# ref 3", ... }

property name* anynullable

Commodity user references metadata.

    {
        "part_number": "5218487281",
        "reference1": "# ref 1",
        "reference2": "# ref 2",
        "reference3": "# ref 3",
        ...
    }
    </details>
    

]

reference_number stringnullable

Possible values: <= 100 characters

The parcel reference number.
(can be used as tracking number for custom carriers)

freight_class stringnullable

Possible values: <= 6 characters

The parcel's freight class for pallet and freight shipments.

options

object

Parcel specific options.

{ "insurance": "100.00", "insured_by": "carrier", }

property name* any

Default value: [object Object]

Parcel specific options.

    {
        "insurance": "100.00",
        "insured_by": "carrier",
    }
    </details>
    

]

options

object

The options available for the shipment.

{ "currency": "USD", "insurance": 100.00, "cash_on_delivery": 30.00, "dangerous_good": true, "declared_value": 150.00, "sms_notification": true, "email_notification": true, "email_notification_to": "shipper@mail.com", "hold_at_location": true, "paperless_trade": true, "preferred_service": "fedex_express_saver", "shipment_date": "2020-01-01", # TODO: deprecate "shipping_date": "2020-01-01T00:00", "shipment_note": "This is a shipment note", "signature_confirmation": true, "saturday_delivery": true, "is_return": true, "doc_files": [ { "doc_type": "commercial_invoice", "doc_file": "base64 encoded file", "doc_name": "commercial_invoice.pdf", "doc_format": "pdf", } ], "doc_references": [ { "doc_id": "123456789", "doc_type": "commercial_invoice", } ], }

property name* any

Default value: [object Object]

The options available for the shipment.

    {
        "currency": "USD",
        "insurance": 100.00,
        "cash_on_delivery": 30.00,
        "dangerous_good": true,
        "declared_value": 150.00,
        "sms_notification": true,
        "email_notification": true,
        "email_notification_to": "shipper@mail.com",
        "hold_at_location": true,
        "paperless_trade": true,
        "preferred_service": "fedex_express_saver",
        "shipment_date": "2020-01-01",  # TODO: deprecate
        "shipping_date": "2020-01-01T00:00",
        "shipment_note": "This is a shipment note",
        "signature_confirmation": true,
        "saturday_delivery": true,
        "is_return": true,
        "doc_files": [
            {
                "doc_type": "commercial_invoice",
                "doc_file": "base64 encoded file",
                "doc_name": "commercial_invoice.pdf",
                "doc_format": "pdf",
            }
        ],
        "doc_references": [
            {
                "doc_id": "123456789",
                "doc_type": "commercial_invoice",
            }
        ],
    }
    </details>
    

payment

object

paid_by string

Possible values: [sender, recipient, third_party]

Default value: sender

The payor type

currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ``, null]

The payment amount currency

account_number stringnullable

The payor account number

customs

object

nullable

commodities

object[]

required

The parcel content items

Array [

weight doublerequired

The commodity's weight

weight_unit stringrequired

Possible values: [KG, LB, OZ, G]

The commodity's weight unit

title stringnullable

Possible values: <= 35 characters

A description of the commodity

description stringnullable

Possible values: <= 100 characters

A description of the commodity

quantity integer

Default value: 1

The commodity's quantity (number or item)

sku stringnullable

Possible values: <= 35 characters

The commodity's sku number

hs_code stringnullable

Possible values: <= 35 characters

The commodity's hs_code number

value_amount doublenullable

The monetary value of the commodity

value_currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, null]

The currency of the commodity value amount

origin_country stringnullable

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX, null]

The origin or manufacture country

parent_id stringnullable

The id of the related order line item.

metadata objectnullable

Commodity user references metadata.

    {
        "part_number": "5218487281",
        "reference1": "# ref 1",
        "reference2": "# ref 2",
        "reference3": "# ref 3",
        ...
    }
    </details>
    

]

duty

object

nullable

The payment details.
Note that this is required for a Dutiable parcel shipped internationally.

paid_by stringnullable

Possible values: [sender, recipient, third_party, ``, null]

The duty payer

currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ``, null]

The declared value currency

declared_value doublenullable

The package declared value

account_number stringnullable

The duty payment account number

duty_billing_address

object

nullable

The duty payor address.

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

content_type stringnullable

Possible values: [documents, gift, sample, merchandise, return_merchandise, other, ``, null]

content_description stringnullable

incoterm stringnullable

Possible values: [CFR, CIF, CIP, CPT, DAP, DAF, DDP, DDU, DEQ, DES, EXW, FAS, FCA, FOB, null]

The customs 'term of trade' also known as 'incoterm'

invoice stringnullable

Possible values: <= 50 characters

The invoice reference number

invoice_date stringnullable

The invoice date.
Date Format: YYYY-MM-DD

commercial_invoice booleannullable

Indicates if the shipment is commercial

certify booleannullable

Indicate that signer certified confirmed all

signer stringnullable

Possible values: <= 50 characters

options object

Default value: [object Object]

Customs identification options.

    {
        "aes": "5218487281",
        "eel_pfc": "5218487281",
        "license_number": "5218487281",
        "certificate_number": "5218487281",
        "nip_number": "5218487281",
        "eori_number": "5218487281",
        "vat_registration_number": "5218487281",
    }
    </details>
    
reference stringnullable

Possible values: <= 35 characters

The shipment reference

label_type string

Possible values: [PDF, ZPL, PNG]

Default value: PDF

The shipment label file type.

service string

Specify a service to Buy a label in one call without rating.

services string[]nullable

Default value: ``

The requested carrier service for the shipment.
Please consult the reference for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier.

carrier_ids string[]nullable

Default value: ``

The list of configured carriers you wish to get rates from.
Note that the request will be sent to all carriers in nothing is specified

metadata

object

User metadata for the shipment

property name* any

Default value: [object Object]

User metadata for the shipment

Responses

201

application/json

Schema

Schema

id string

A unique identifier

object_type string

Default value: shipment

Specifies the object type

tracking_url urinullable

The shipment tracking url

shipper

object

required

id string

A unique identifier

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

object_type string

Default value: address

Specifies the object type

validation

object

nullable

Specify address validation result

success booleanrequired

True if the address is valid

meta objectnullable

validation service details

recipient

object

required

id string

A unique identifier

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

object_type string

Default value: address

Specifies the object type

validation

object

nullable

Specify address validation result

success booleanrequired

True if the address is valid

meta objectnullable

validation service details

return_address

object

nullable

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

billing_address

object

nullable

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

parcels

object[]

required

The shipment's parcels

Array [

id string

A unique identifier

weight doublerequired

The parcel's weight

width doublenullable

The parcel's width

height doublenullable

The parcel's height

length doublenullable

The parcel's length

packaging_type stringnullable

Possible values: <= 50 characters

The parcel's packaging type.
Note that the packaging is optional when using a package preset.
values:
envelope pak tube pallet small_box medium_box your_packaging
For carrier specific packaging types, please consult the reference.

package_preset stringnullable

Possible values: <= 50 characters

The parcel's package preset.
For carrier specific package presets, please consult the reference.

description stringnullable

Possible values: <= 250 characters

The parcel's description

content stringnullable

Possible values: <= 100 characters

The parcel's content description

is_document booleannullable

Indicates if the parcel is composed of documents only

weight_unit stringrequired

Possible values: [KG, LB, OZ, G]

The parcel's weight unit

dimension_unit stringnullable

Possible values: [CM, IN, null]

The parcel's dimension unit

items

object[]

The parcel items.

Array [

id string

A unique identifier

weight doublerequired

The commodity's weight

weight_unit stringrequired

Possible values: [KG, LB, OZ, G]

The commodity's weight unit

title stringnullable

Possible values: <= 35 characters

A description of the commodity

description stringnullable

Possible values: <= 100 characters

A description of the commodity

quantity integer

Default value: 1

The commodity's quantity (number or item)

sku stringnullable

Possible values: <= 35 characters

The commodity's sku number

hs_code stringnullable

Possible values: <= 35 characters

The commodity's hs_code number

value_amount doublenullable

The monetary value of the commodity

value_currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, null]

The currency of the commodity value amount

origin_country stringnullable

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX, null]

The origin or manufacture country

parent_id stringnullable

The id of the related order line item.

metadata

object

nullable

Commodity user references metadata.

{ "part_number": "5218487281", "reference1": "# ref 1", "reference2": "# ref 2", "reference3": "# ref 3", ... }

property name* anynullable

Commodity user references metadata.

    {
        "part_number": "5218487281",
        "reference1": "# ref 1",
        "reference2": "# ref 2",
        "reference3": "# ref 3",
        ...
    }
    </details>
    

object_type string

Default value: commodity

Specifies the object type

]

reference_number stringnullable

Possible values: <= 100 characters

The parcel reference number.
(can be used as tracking number for custom carriers)

freight_class stringnullable

Possible values: <= 6 characters

The parcel's freight class for pallet and freight shipments.

options

object

Parcel specific options.

{ "insurance": "100.00", "insured_by": "carrier", }

property name* any

Default value: [object Object]

Parcel specific options.

    {
        "insurance": "100.00",
        "insured_by": "carrier",
    }
    </details>
    

object_type string

Default value: parcel

Specifies the object type

]

services string[]nullable

Default value: ``

The carriers services requested for the shipment.
Please consult the reference for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier.

options

object

The options available for the shipment.

{ "currency": "USD", "insurance": 100.00, "cash_on_delivery": 30.00, "dangerous_good": true, "declared_value": 150.00, "sms_notification": true, "email_notification": true, "email_notification_to": "shipper@mail.com", "hold_at_location": true, "paperless_trade": true, "preferred_service": "fedex_express_saver", "shipment_date": "2020-01-01", # TODO: deprecate "shipping_date": "2020-01-01T00:00", "shipment_note": "This is a shipment note", "signature_confirmation": true, "saturday_delivery": true, "is_return": true, "doc_files": [ { "doc_type": "commercial_invoice", "doc_file": "base64 encoded file", "doc_name": "commercial_invoice.pdf", "doc_format": "pdf", } ], "doc_references": [ { "doc_id": "123456789", "doc_type": "commercial_invoice", } ], }

property name* any

Default value: [object Object]

The options available for the shipment.

    {
        "currency": "USD",
        "insurance": 100.00,
        "cash_on_delivery": 30.00,
        "dangerous_good": true,
        "declared_value": 150.00,
        "sms_notification": true,
        "email_notification": true,
        "email_notification_to": "shipper@mail.com",
        "hold_at_location": true,
        "paperless_trade": true,
        "preferred_service": "fedex_express_saver",
        "shipment_date": "2020-01-01",  # TODO: deprecate
        "shipping_date": "2020-01-01T00:00",
        "shipment_note": "This is a shipment note",
        "signature_confirmation": true,
        "saturday_delivery": true,
        "is_return": true,
        "doc_files": [
            {
                "doc_type": "commercial_invoice",
                "doc_file": "base64 encoded file",
                "doc_name": "commercial_invoice.pdf",
                "doc_format": "pdf",
            }
        ],
        "doc_references": [
            {
                "doc_id": "123456789",
                "doc_type": "commercial_invoice",
            }
        ],
    }
    </details>
    

payment

object

paid_by string

Possible values: [sender, recipient, third_party]

Default value: sender

The payor type

currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ``, null]

The payment amount currency

account_number stringnullable

The payor account number

customs

object

nullable

id string

A unique identifier

commodities

object[]

The parcel content items

Array [

id string

A unique identifier

weight doublerequired

The commodity's weight

weight_unit stringrequired

Possible values: [KG, LB, OZ, G]

The commodity's weight unit

title stringnullable

Possible values: <= 35 characters

A description of the commodity

description stringnullable

Possible values: <= 100 characters

A description of the commodity

quantity integer

Default value: 1

The commodity's quantity (number or item)

sku stringnullable

Possible values: <= 35 characters

The commodity's sku number

hs_code stringnullable

Possible values: <= 35 characters

The commodity's hs_code number

value_amount doublenullable

The monetary value of the commodity

value_currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, null]

The currency of the commodity value amount

origin_country stringnullable

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX, null]

The origin or manufacture country

parent_id stringnullable

The id of the related order line item.

metadata objectnullable

Commodity user references metadata.

    {
        "part_number": "5218487281",
        "reference1": "# ref 1",
        "reference2": "# ref 2",
        "reference3": "# ref 3",
        ...
    }
    </details>
    

object_type string

Default value: commodity

Specifies the object type

]

duty

object

nullable

The payment details.
Note that this is required for a Dutiable parcel shipped internationally.

paid_by stringnullable

Possible values: [sender, recipient, third_party, ``, null]

The duty payer

currency stringnullable

Possible values: [EUR, AED, USD, XCD, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, GBP, GEL, GHS, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NOK, NPR, OMR, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ``, null]

The declared value currency

declared_value doublenullable

The package declared value

account_number stringnullable

The duty payment account number

duty_billing_address

object

nullable

The duty payor address.

id string

A unique identifier

postal_code stringnullable

Possible values: <= 10 characters

The address postal code (required for shipment purchase)

city stringnullable

Possible values: <= 30 characters

The address city. (required for shipment purchase)

federal_tax_id stringnullable

Possible values: <= 20 characters

The party frederal tax id

state_tax_id stringnullable

Possible values: <= 20 characters

The party state id

person_name stringnullable

Possible values: <= 50 characters

Attention to (required for shipment purchase)

company_name stringnullable

Possible values: <= 50 characters

The company name if the party is a company

country_code stringrequired

Possible values: [AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IN, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KV, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TL, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WS, XB, XC, XE, XM, XN, XS, XY, YE, YT, ZA, ZM, ZW, EH, IM, BL, MF, SX]

The address country code

email stringnullable

The party email

phone_number stringnullable

Possible values: <= 20 characters

The party phone number.

state_code stringnullable

Possible values: <= 20 characters

The address state code

residential booleannullable

Indicate if the address is residential or commercial (enterprise)

street_number stringnullable

Possible values: <= 20 characters

The address street number

address_line1 stringnullable

Possible values: <= 50 characters

The address line with street number
(required for shipment purchase)

address_line2 stringnullable

Possible values: <= 50 characters

The address line with suite number

validate_location booleannullable

Indicate if the address should be validated

object_type string

Default value: address

Specifies the object type

validation

object

nullable

Specify address validation result

success booleanrequired

True if the address is valid

meta objectnullable

validation service details

content_type stringnullable

Possible values: [documents, gift, sample, merchandise, return_merchandise, other, ``, null]

content_description stringnullable

incoterm stringnullable

Possible values: [CFR, CIF, CIP, CPT, DAP, DAF, DDP, DDU, DEQ, DES, EXW, FAS, FCA, FOB, null]

The customs 'term of trade' also known as 'incoterm'

invoice stringnullable

Possible values: <= 50 characters

The invoice reference number

invoice_date stringnullable

The invoice date.
Date Format: YYYY-MM-DD

commercial_invoice booleannullable

Indicates if the shipment is commercial

certify booleannullable

Indicate that signer certified confirmed all

signer stringnullable

Possible values: <= 50 characters

options object

Default value: [object Object]

Customs identification options.

    {
        "aes": "5218487281",
        "eel_pfc": "5218487281",
        "license_number": "5218487281",
        "certificate_number": "5218487281",
        "nip_number": "5218487281",
        "eori_number": "5218487281",
        "vat_registration_number": "5218487281",
    }
    </details>
    

object_type string

Default value: customs_info

Specifies the object type

rates

object[]

The list for shipment rates fetched previously

Array [

id string

A unique identifier

object_type string

Default value: rate

Specifies the object type

carrier_name stringrequired

The rate's carrier

carrier_id stringrequired

The targeted carrier's name (unique identifier)

currency string

The rate monetary values currency code

service stringnullable

The carrier's rate (quote) service

total_charge double

Default value: 0

The rate's monetary amount of the total charge.
This is the gross amount of the rate after adding the additional charges

transit_days integernullable

The estimated delivery transit days

extra_charges

object[]

list of the rate's additional charges

Array [

name stringnullable

The charge description

amount doublenullable

The charge monetary value

currency stringnullable

The charge amount currency

]

estimated_delivery stringnullable

The delivery estimated date

meta

object

nullable

provider specific metadata

property name* anynullable

provider specific metadata

test_mode booleanrequired

Specified whether it was created with a carrier in test mode

]

reference stringnullable

The shipment reference

label_type stringnullable

Possible values: [PDF, ZPL, PNG, ``, null]

The shipment label file type.

carrier_ids string[]nullable

Default value: ``

The list of configured carriers you wish to get rates from.
Note that the request will be sent to all carriers in nothing is specified

tracker_id stringnullable

The attached tracker id

created_at stringrequired

The shipment creation datetime.
Date Format: YYYY-MM-DD HH:MM:SS.mmmmmmz

metadata

object

User metadata for the shipment

property name* any

Default value: [object Object]

User metadata for the shipment

messages

object[]

The list of note or warning messages

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

carrier_name string

The targeted carrier

carrier_id string

The targeted carrier name (unique identifier)

]

status string

Possible values: [draft, purchased, cancelled, shipped, in_transit, delivered, needs_attention, out_for_delivery, delivery_failed]

Default value: draft

The current Shipment status

carrier_name stringnullable

The shipment carrier

carrier_id stringnullable

The shipment carrier configured identifier

tracking_number stringnullable

The shipment tracking number

shipment_identifier stringnullable

The shipment carrier system identifier

selected_rate

object

nullable

id string

A unique identifier

object_type string

Default value: rate

Specifies the object type

carrier_name stringrequired

The rate's carrier

carrier_id stringrequired

The targeted carrier's name (unique identifier)

currency string

The rate monetary values currency code

service stringnullable

The carrier's rate (quote) service

total_charge double

Default value: 0

The rate's monetary amount of the total charge.
This is the gross amount of the rate after adding the additional charges

transit_days integernullable

The estimated delivery transit days

extra_charges

object[]

list of the rate's additional charges

Array [

name stringnullable

The charge description

amount doublenullable

The charge monetary value

currency stringnullable

The charge amount currency

]

estimated_delivery stringnullable

The delivery estimated date

meta objectnullable

provider specific metadata

test_mode booleanrequired

Specified whether it was created with a carrier in test mode

meta

object

nullable

provider specific metadata

property name* anynullable

provider specific metadata

service stringnullable

The selected service

selected_rate_id stringnullable

The shipment selected rate.

test_mode booleanrequired

Specified whether it was created with a carrier in test mode

label_url urinullable

The shipment label URL

invoice_url urinullable

The shipment invoice URL

Example (from schema)

{
  "id": "string",
  "object_type": "shipment",
  "tracking_url": "string",
  "shipper": {
    "id": "string",
    "postal_code": "string",
    "city": "string",
    "federal_tax_id": "string",
    "state_tax_id": "string",
    "person_name": "string",
    "company_name": "string",
    "country_code": "AC",
    "email": "string",
    "phone_number": "string",
    "state_code": "string",
    "residential": false,
    "street_number": "string",
    "address_line1": "string",
    "address_line2": "string",
    "validate_location": false,
    "object_type": "address",
    "validation": {
      "success": true,
      "meta": {}
    }
  },
  "recipient": {
    "id": "string",
    "postal_code": "string",
    "city": "string",
    "federal_tax_id": "string",
    "state_tax_id": "string",
    "person_name": "string",
    "company_name": "string",
    "country_code": "AC",
    "email": "string",
    "phone_number": "string",
    "state_code": "string",
    "residential": false,
    "street_number": "string",
    "address_line1": "string",
    "address_line2": "string",
    "validate_location": false,
    "object_type": "address",
    "validation": {
      "success": true,
      "meta": {}
    }
  },
  "return_address": {
    "postal_code": "string",
    "city": "string",
    "federal_tax_id": "string",
    "state_tax_id": "string",
    "person_name": "string",
    "company_name": "string",
    "country_code": "AC",
    "email": "string",
    "phone_number": "string",
    "state_code": "string",
    "residential": false,
    "street_number": "string",
    "address_line1": "string",
    "address_line2": "string",
    "validate_location": false
  },
  "billing_address": {
    "postal_code": "string",
    "city": "string",
    "federal_tax_id": "string",
    "state_tax_id": "string",
    "person_name": "string",
    "company_name": "string",
    "country_code": "AC",
    "email": "string",
    "phone_number": "string",
    "state_code": "string",
    "residential": false,
    "street_number": "string",
    "address_line1": "string",
    "address_line2": "string",
    "validate_location": false
  },
  "parcels": [
    {
      "id": "string",
      "weight": 0,
      "width": 0,
      "height": 0,
      "length": 0,
      "packaging_type": "string",
      "package_preset": "string",
      "description": "string",
      "content": "string",
      "is_document": false,
      "weight_unit": "KG",
      "dimension_unit": "CM",
      "items": [
        {
          "id": "string",
          "weight": 0,
          "weight_unit": "KG",
          "title": "string",
          "description": "string",
          "quantity": 1,
          "sku": "string",
          "hs_code": "string",
          "value_amount": 0,
          "value_currency": "EUR",
          "origin_country": "AC",
          "parent_id": "string",
          "metadata": {},
          "object_type": "commodity"
        }
      ],
      "reference_number": "string",
      "freight_class": "string",
      "options": {},
      "object_type": "parcel"
    }
  ],
  "services": [
    "string"
  ],
  "options": {},
  "payment": {
    "paid_by": "sender",
    "currency": "EUR",
    "account_number": "string"
  },
  "customs": {
    "id": "string",
    "commodities": [
      {
        "id": "string",
        "weight": 0,
        "weight_unit": "KG",
        "title": "string",
        "description": "string",
        "quantity": 1,
        "sku": "string",
        "hs_code": "string",
        "value_amount": 0,
        "value_currency": "EUR",
        "origin_country": "AC",
        "parent_id": "string",
        "metadata": {},
        "object_type": "commodity"
      }
    ],
    "duty": {
      "paid_by": "sender",
      "currency": "EUR",
      "declared_value": 0,
      "account_number": "string"
    },
    "duty_billing_address": {
      "id": "string",
      "postal_code": "string",
      "city": "string",
      "federal_tax_id": "string",
      "state_tax_id": "string",
      "person_name": "string",
      "company_name": "string",
      "country_code": "AC",
      "email": "string",
      "phone_number": "string",
      "state_code": "string",
      "residential": false,
      "street_number": "string",
      "address_line1": "string",
      "address_line2": "string",
      "validate_location": false,
      "object_type": "address",
      "validation": {
        "success": true,
        "meta": {}
      }
    },
    "content_type": "documents",
    "content_description": "string",
    "incoterm": "CFR",
    "invoice": "string",
    "invoice_date": "string",
    "commercial_invoice": true,
    "certify": true,
    "signer": "string",
    "options": {},
    "object_type": "customs_info"
  },
  "rates": [
    {
      "id": "string",
      "object_type": "rate",
      "carrier_name": "string",
      "carrier_id": "string",
      "currency": "string",
      "service": "string",
      "total_charge": 0,
      "transit_days": 0,
      "extra_charges": [
        {
          "name": "string",
          "amount": 0,
          "currency": "string"
        }
      ],
      "estimated_delivery": "string",
      "meta": {},
      "test_mode": true
    }
  ],
  "reference": "string",
  "label_type": "PDF",
  "carrier_ids": [
    "string"
  ],
  "tracker_id": "string",
  "created_at": "string",
  "metadata": {},
  "messages": [
    {
      "message": "string",
      "code": "string",
      "details": {},
      "carrier_name": "string",
      "carrier_id": "string"
    }
  ],
  "status": "draft",
  "carrier_name": "string",
  "carrier_id": "string",
  "tracking_number": "string",
  "shipment_identifier": "string",
  "selected_rate": {
    "id": "string",
    "object_type": "rate",
    "carrier_name": "string",
    "carrier_id": "string",
    "currency": "string",
    "service": "string",
    "total_charge": 0,
    "transit_days": 0,
    "extra_charges": [
      {
        "name": "string",
        "amount": 0,
        "currency": "string"
      }
    ],
    "estimated_delivery": "string",
    "meta": {},
    "test_mode": true
  },
  "meta": {},
  "service": "string",
  "selected_rate_id": "string",
  "test_mode": true,
  "label_url": "string",
  "invoice_url": "string"
}

400

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

424

application/json

Schema

Schema

messages

object[]

The list of error messages

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

carrier_name string

The targeted carrier

carrier_id string

The targeted carrier name (unique identifier)

]

Example (from schema)

{
  "messages": [
    {
      "message": "string",
      "code": "string",
      "details": {},
      "carrier_name": "string",
      "carrier_id": "string"
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...