Create shipment batch
POST/v1/batches/shipments
Create shipment batch. Beta
Request
- application/json
Body
required
Array [
Array [
Array [
]
]
Array [
]
]
shipments
object[]
required
The list of shipments to process.
recipient
object
required
Possible values: <= 10 characters
The address postal code (required for shipment purchase)
Possible values: <= 30 characters
The address city. (required for shipment purchase)
Possible values: <= 20 characters
The party frederal tax id
Possible values: <= 20 characters
The party state id
Possible values: <= 50 characters
Attention to (required for shipment purchase)
Possible values: <= 50 characters
The company name if the party is a company
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
The party email
Possible values: <= 20 characters
The party phone number.
Possible values: <= 20 characters
The address state code
Indicate if the address is residential or commercial (enterprise)
Possible values: <= 20 characters
The address street number
Possible values: <= 50 characters
The address line with street number
(required for shipment purchase)
Possible values: <= 50 characters
The address line with suite number
Indicate if the address should be validated
shipper
object
required
Possible values: <= 10 characters
The address postal code (required for shipment purchase)
Possible values: <= 30 characters
The address city. (required for shipment purchase)
Possible values: <= 20 characters
The party frederal tax id
Possible values: <= 20 characters
The party state id
Possible values: <= 50 characters
Attention to (required for shipment purchase)
Possible values: <= 50 characters
The company name if the party is a company
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
The party email
Possible values: <= 20 characters
The party phone number.
Possible values: <= 20 characters
The address state code
Indicate if the address is residential or commercial (enterprise)
Possible values: <= 20 characters
The address street number
Possible values: <= 50 characters
The address line with street number
(required for shipment purchase)
Possible values: <= 50 characters
The address line with suite number
Indicate if the address should be validated
return_address
object
nullable
Possible values: <= 10 characters
The address postal code (required for shipment purchase)
Possible values: <= 30 characters
The address city. (required for shipment purchase)
Possible values: <= 20 characters
The party frederal tax id
Possible values: <= 20 characters
The party state id
Possible values: <= 50 characters
Attention to (required for shipment purchase)
Possible values: <= 50 characters
The company name if the party is a company
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
The party email
Possible values: <= 20 characters
The party phone number.
Possible values: <= 20 characters
The address state code
Indicate if the address is residential or commercial (enterprise)
Possible values: <= 20 characters
The address street number
Possible values: <= 50 characters
The address line with street number
(required for shipment purchase)
Possible values: <= 50 characters
The address line with suite number
Indicate if the address should be validated
billing_address
object
nullable
Possible values: <= 10 characters
The address postal code (required for shipment purchase)
Possible values: <= 30 characters
The address city. (required for shipment purchase)
Possible values: <= 20 characters
The party frederal tax id
Possible values: <= 20 characters
The party state id
Possible values: <= 50 characters
Attention to (required for shipment purchase)
Possible values: <= 50 characters
The company name if the party is a company
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
The party email
Possible values: <= 20 characters
The party phone number.
Possible values: <= 20 characters
The address state code
Indicate if the address is residential or commercial (enterprise)
Possible values: <= 20 characters
The address street number
Possible values: <= 50 characters
The address line with street number
(required for shipment purchase)
Possible values: <= 50 characters
The address line with suite number
Indicate if the address should be validated
parcels
object[]
required
The shipment's parcels
The parcel's weight
The parcel's width
The parcel's height
The parcel's length
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.
Possible values: <= 50 characters
The parcel's package preset.
For carrier specific package presets, please consult the reference.
Possible values: <= 250 characters
The parcel's description
Possible values: <= 100 characters
The parcel's content description
Indicates if the parcel is composed of documents only
Possible values: [KG, LB, OZ, G]
The parcel's weight unit
Possible values: [CM, IN, null]
The parcel's dimension unit
items
object[]
The parcel items.
The commodity's weight
Possible values: [KG, LB, OZ, G]
The commodity's weight unit
Possible values: <= 35 characters
A description of the commodity
Possible values: <= 100 characters
A description of the commodity
Default value: 1
The commodity's quantity (number or item)
Possible values: <= 35 characters
The commodity's sku number
Possible values: <= 35 characters
The commodity's hs_code number
The monetary value of the commodity
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
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
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", ... }
Commodity user references metadata.
{
"part_number": "5218487281",
"reference1": "# ref 1",
"reference2": "# ref 2",
"reference3": "# ref 3",
...
}
</details>
Possible values: <= 100 characters
The parcel reference number.
(can be used as tracking number for custom carriers)
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", }
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", } ], }
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
Possible values: [sender, recipient, third_party]
Default value: sender
The payor type
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
The payor account number
customs
object
nullable
commodities
object[]
required
The parcel content items
The commodity's weight
Possible values: [KG, LB, OZ, G]
The commodity's weight unit
Possible values: <= 35 characters
A description of the commodity
Possible values: <= 100 characters
A description of the commodity
Default value: 1
The commodity's quantity (number or item)
Possible values: <= 35 characters
The commodity's sku number
Possible values: <= 35 characters
The commodity's hs_code number
The monetary value of the commodity
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
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
The id of the related order line item.
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.
Possible values: [sender, recipient, third_party, ``, null]
The duty payer
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
The package declared value
The duty payment account number
duty_billing_address
object
nullable
The duty payor address.
Possible values: <= 10 characters
The address postal code (required for shipment purchase)
Possible values: <= 30 characters
The address city. (required for shipment purchase)
Possible values: <= 20 characters
The party frederal tax id
Possible values: <= 20 characters
The party state id
Possible values: <= 50 characters
Attention to (required for shipment purchase)
Possible values: <= 50 characters
The company name if the party is a company
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
The party email
Possible values: <= 20 characters
The party phone number.
Possible values: <= 20 characters
The address state code
Indicate if the address is residential or commercial (enterprise)
Possible values: <= 20 characters
The address street number
Possible values: <= 50 characters
The address line with street number
(required for shipment purchase)
Possible values: <= 50 characters
The address line with suite number
Indicate if the address should be validated
Possible values: [documents, gift, sample, merchandise, return_merchandise, other, ``, null]
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'
Possible values: <= 50 characters
The invoice reference number
The invoice date.
Date Format: YYYY-MM-DD
Indicates if the shipment is commercial
Indicate that signer certified confirmed all
Possible values: <= 50 characters
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>
Possible values: <= 35 characters
The shipment reference
Possible values: [PDF, ZPL, PNG]
Default value: PDF
The shipment label file type.
Specify a service to Buy a label in one call without rating.
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.
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
Default value: [object Object]
User metadata for the shipment
The shipment id.
Responses
- 200
- 404
- 500
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
A unique identifier
Possible values: [queued, running, failed, completed, completed_with_errors]
Possible values: [orders, shipments, trackers, billing]
resources
object[]
required
A unique identifier
Possible values: [queued, running, failed, completed, completed_with_errors]
The batch operation resource status
errors
object
nullable
Resource processing errors
Resource processing errors
{
"id": "string",
"status": "queued",
"resource_type": "orders",
"resources": [
{
"id": "string",
"status": "queued",
"errors": {}
}
],
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"test_mode": true
}
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
The list of API errors
The error or warning message
The message code
details
object
any additional details
any additional details
{
"errors": [
{
"message": "string",
"code": "string",
"details": {}
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
The list of API errors
The error or warning message
The message code
details
object
any additional details
any additional details
{
"errors": [
{
"message": "string",
"code": "string",
"details": {}
}
]
}