Cancel a shipment
POST/v1/shipments/:id/cancel
Void a shipment with the associated label.
Request
Path Parameters
Responses
- 200
- 400
- 404
- 409
- 424
- 500
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
A unique identifier
Default value: shipment
Specifies the object type
The shipment tracking url
shipper
object
required
A unique identifier
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
Default value: address
Specifies the object type
validation
object
nullable
Specify address validation result
True if the address is valid
validation service details
recipient
object
required
A unique identifier
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
Default value: address
Specifies the object type
validation
object
nullable
Specify address validation result
True if the address is valid
validation service details
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
A unique identifier
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.
A unique identifier
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>
Default value: commodity
Specifies the object type
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>
Default value: parcel
Specifies the object type
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", "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",
"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
A unique identifier
commodities
object[]
The parcel content items
A unique identifier
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>
Default value: commodity
Specifies the object type
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.
A unique identifier
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
Default value: address
Specifies the object type
validation
object
nullable
Specify address validation result
True if the address is valid
validation service details
Possible values: [documents
, gift
, sample
, merchandise
, return_merchandise
, other
, ``, null
]
Possible values: [CFR
, CIF
, CIP
, CPT
, 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>
Default value: customs_info
Specifies the object type
rates
object[]
The list for shipment rates fetched previously
A unique identifier
Default value: rate
Specifies the object type
The rate's carrier
The targeted carrier's name (unique identifier)
The rate monetary values currency code
The carrier's rate (quote) service
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
The estimated delivery transit days
extra_charges
object[]
list of the rate's additional charges
The charge description
The charge monetary value
The charge amount currency
The delivery estimated date
meta
object
nullable
provider specific metadata
provider specific metadata
Specified whether it was created with a carrier in test mode
The shipment reference
Possible values: [PDF
, ZPL
, PNG
, ``, null
]
The shipment label file type.
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
The attached tracker id
The shipment creation datetime.
Date Format: YYYY-MM-DD HH:MM:SS.mmmmmmz
metadata
object
User metadata for the shipment
Default value: [object Object]
User metadata for the shipment
messages
object[]
The list of note or warning messages
The error or warning message
The message code
details
object
any additional details
any additional details
The targeted carrier
The targeted carrier name (unique identifier)
Possible values: [draft
, purchased
, cancelled
, shipped
, in_transit
, delivered
, needs_attention
, out_for_delivery
, delivery_failed
]
Default value: draft
The current Shipment status
The shipment carrier
The shipment carrier configured identifier
The shipment tracking number
The shipment carrier system identifier
selected_rate
object
nullable
A unique identifier
Default value: rate
Specifies the object type
The rate's carrier
The targeted carrier's name (unique identifier)
The rate monetary values currency code
The carrier's rate (quote) service
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
The estimated delivery transit days
extra_charges
object[]
list of the rate's additional charges
The charge description
The charge monetary value
The charge amount currency
The delivery estimated date
provider specific metadata
Specified whether it was created with a carrier in test mode
meta
object
nullable
provider specific metadata
provider specific metadata
The selected service
The shipment selected rate.
Specified whether it was created with a carrier in test mode
The shipment label URL
The shipment invoice URL
{
"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"
}
- 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": {}
}
]
}
- 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 [
]
messages
object[]
The list of error messages
The error or warning message
The message code
details
object
any additional details
any additional details
The targeted carrier
The targeted carrier name (unique identifier)
{
"messages": [
{
"message": "string",
"code": "string",
"details": {},
"carrier_name": "string",
"carrier_id": "string"
}
]
}
- 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": {}
}
]
}