Schedule a pickup
POST/v1/proxy/pickups/:carrier_name
Schedule one or many parcels pickup
Request
Path Parameters
Possible values: [allied_express, allied_express_local, amazon_shipping, aramex, asendia_us, australiapost, boxknight, bpost, canadapost, canpar, chronopost, colissimo, dhl_express, dhl_parcel_de, dhl_poland, dhl_universal, dicom, dpd, dpdhl, easypost, easyship, eshipper, fedex, fedex_ws, freightcom, generic, geodis, hay_post, laposte, locate2u, nationex, purolator, roadie, royalmail, sapient, seko, sendle, tge, tnt, ups, usps, usps_international, usps_wt, usps_wt_international, zoom2u]
- application/json
Body
required
Array [
Array [
]
]
The expected pickup date.
Date Format: YYYY-MM-DD
address
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
parcels
object[]
required
The shipment parcels to pickup.
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>
The ready time for pickup.
Time Format: HH:MM
The closing or late time of the pickup.
Time Format: HH:MM
Possible values: <= 50 characters
The pickup instruction.
eg: Handle with care.
Possible values: <= 50 characters
The package(s) location.
eg: Behind the entrance door.
options
object
nullable
Advanced carrier specific pickup options
Advanced carrier specific pickup options
Responses
- 201
- 400
- 424
- 500
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
]
]
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)
pickup
object
A unique pickup identifier
Default value: pickup
Specifies the object type
The pickup carrier
The pickup carrier configured name
The pickup confirmation identifier
The pickup date
pickup_charge
object
nullable
The pickup cost details
The charge description
The charge monetary value
The charge amount currency
The pickup expected ready time
The pickup expected closing or late time
Default value: [object Object]
User metadata for the pickup
provider specific metadata
address
object
required
The pickup 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
parcels
object[]
required
The shipment parcels to pickup.
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.
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.
Default value: [object Object]
Parcel specific options.
{
"insurance": "100.00",
"insured_by": "carrier",
}
</details>
Default value: parcel
Specifies the object type
Possible values: <= 50 characters
The pickup instruction.
eg: Handle with care.
Possible values: <= 50 characters
The package(s) location.
eg: Behind the entrance door.
Advanced carrier specific pickup options
Specified whether it was created with a carrier in test mode
{
"messages": [
{
"message": "string",
"code": "string",
"details": {},
"carrier_name": "string",
"carrier_id": "string"
}
],
"pickup": {
"id": "string",
"object_type": "pickup",
"carrier_name": "string",
"carrier_id": "string",
"confirmation_number": "string",
"pickup_date": "string",
"pickup_charge": {
"name": "string",
"amount": 0,
"currency": "string"
},
"ready_time": "string",
"closing_time": "string",
"metadata": {},
"meta": {},
"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": {}
}
},
"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"
}
],
"instruction": "string",
"package_location": "string",
"options": {},
"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 [
]
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": {}
}
]
}