Skip to main content

Remove a parcel

DELETE 
/v1/parcels/:id

Remove a parcel.

Request​

Path Parameters

    id stringrequired

Responses​

Schema

    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

Loading...