---
title: "Update an order"
method: PUT
path: "/v1/orders/{id}"
tags: ["Orders"]
---

# Update an order

`PUT /v1/orders/{id}`

This operation allows for updating properties of an order including `options` and `metadata`.
It is not for editing the line items of an order.

## Path parameters

- `id` string, required

## Request body

- OrderUpdateData
  - `options` object, nullable — <details> <summary>The options available for the order shipments.</summary> { "currency": "USD", "paid_by": "third_party", "payment_account_number": "123456789", "duty_paid_by": "recipient", "duty_account_number": "123456789", "invoice_number": "123456789", "invoice_date": "2020-01-01", "single_item_per_parcel": true, "carrier_ids": ["canadapost-test"], } </details>
  - `metadata` object — User metadata for the shipment

## Response `200`

- Order
  - `id` string — A unique identifier
  - `object_type` string — Specifies the object type
  - `order_id` string, required — The source' order id.
  - `order_date` string, nullable — The order date. format: `YYYY-MM-DD`
  - `source` string — The order's source.
  - `status` 'unfulfilled' | 'cancelled' | 'fulfilled' | 'delivered' | 'partial' — The order status.
  - `shipping_to` Address, required
    - `id` string — A unique identifier
    - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
    - `city` string, nullable — The address city. **(required for shipment purchase)**
    - `federal_tax_id` string, nullable — The party frederal tax id
    - `state_tax_id` string, nullable — The party state id
    - `person_name` string, nullable — Attention to **(required for shipment purchase)**
    - `company_name` string, nullable — The company name if the party is a company
    - `country_code` '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', required — The address country code
    - `email` string, nullable — The party email
    - `phone_number` string, nullable — The party phone number.
    - `state_code` string, nullable — The address state code
    - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
    - `street_number` string, nullable — The address street number
    - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
    - `address_line2` string, nullable — The address line with suite number
    - `validate_location` boolean, nullable — Indicate if the address should be validated
    - `object_type` string — Specifies the object type
    - `validation` AddressValidation
      - `success` boolean, required — True if the address is valid
      - `meta` object, nullable — validation service details
  - `shipping_from` Address
    - `id` string — A unique identifier
    - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
    - `city` string, nullable — The address city. **(required for shipment purchase)**
    - `federal_tax_id` string, nullable — The party frederal tax id
    - `state_tax_id` string, nullable — The party state id
    - `person_name` string, nullable — Attention to **(required for shipment purchase)**
    - `company_name` string, nullable — The company name if the party is a company
    - `country_code` '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', required — The address country code
    - `email` string, nullable — The party email
    - `phone_number` string, nullable — The party phone number.
    - `state_code` string, nullable — The address state code
    - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
    - `street_number` string, nullable — The address street number
    - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
    - `address_line2` string, nullable — The address line with suite number
    - `validate_location` boolean, nullable — Indicate if the address should be validated
    - `object_type` string — Specifies the object type
    - `validation` AddressValidation
      - `success` boolean, required — True if the address is valid
      - `meta` object, nullable — validation service details
  - `billing_address` AddressData
    - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
    - `city` string, nullable — The address city. **(required for shipment purchase)**
    - `federal_tax_id` string, nullable — The party frederal tax id
    - `state_tax_id` string, nullable — The party state id
    - `person_name` string, nullable — Attention to **(required for shipment purchase)**
    - `company_name` string, nullable — The company name if the party is a company
    - `country_code` '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', required — The address country code
    - `email` string, nullable — The party email
    - `phone_number` string, nullable — The party phone number.
    - `state_code` string, nullable — The address state code
    - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
    - `street_number` string, nullable — The address street number
    - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
    - `address_line2` string, nullable — The address line with suite number
    - `validate_location` boolean, nullable — Indicate if the address should be validated
  - `line_items` LineItem[], required — The order line items.
    - `id` string — A unique identifier
    - `weight` number, double, required — The commodity's weight
    - `weight_unit` 'KG' | 'LB' | 'OZ' | 'G', required — The commodity's weight unit
    - `title` string, nullable — A description of the commodity
    - `description` string, nullable — A description of the commodity
    - `quantity` integer — The commodity's quantity (number or item)
    - `sku` string, nullable — The commodity's sku number
    - `hs_code` string, nullable — The commodity's hs_code number
    - `value_amount` number, double, nullable — The monetary value of the commodity
    - `value_currency` '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', nullable — The currency of the commodity value amount
    - `origin_country` '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', nullable — The origin or manufacture country
    - `parent_id` string, nullable — The id of the related order line item.
    - `metadata` object, nullable — <details> <summary>Commodity user references metadata.</summary> { "part_number": "5218487281", "reference1": "# ref 1", "reference2": "# ref 2", "reference3": "# ref 3", ... } </details>
    - `object_type` string — Specifies the object type
    - `unfulfilled_quantity` integer
  - `options` object, nullable — <details> <summary>The options available for the order shipments.</summary> { "currency": "USD", "paid_by": "third_party", "payment_account_number": "123456789", "duty_paid_by": "third_party", "duty_account_number": "123456789", "invoice_number": "123456789", "invoice_date": "2020-01-01", "single_item_per_parcel": true, "carrier_ids": ["canadapost-test"], "preferred_service": "fedex_express_saver", } </details>
  - `meta` object, nullable — system related metadata.
  - `metadata` object — User metadata for the order.
  - `shipments` Shipment[] — The shipments associated with the order.
    - `id` string — A unique identifier
    - `object_type` string — Specifies the object type
    - `tracking_url` string, uri, nullable — The shipment tracking url
    - `shipper` Address, required
      - `id` string — A unique identifier
      - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
      - `city` string, nullable — The address city. **(required for shipment purchase)**
      - `federal_tax_id` string, nullable — The party frederal tax id
      - `state_tax_id` string, nullable — The party state id
      - `person_name` string, nullable — Attention to **(required for shipment purchase)**
      - `company_name` string, nullable — The company name if the party is a company
      - `country_code` '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', required — The address country code
      - `email` string, nullable — The party email
      - `phone_number` string, nullable — The party phone number.
      - `state_code` string, nullable — The address state code
      - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
      - `street_number` string, nullable — The address street number
      - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
      - `address_line2` string, nullable — The address line with suite number
      - `validate_location` boolean, nullable — Indicate if the address should be validated
      - `object_type` string — Specifies the object type
      - `validation` AddressValidation
        - `success` boolean, required — True if the address is valid
        - `meta` object, nullable — validation service details
    - `recipient` Address, required
      - `id` string — A unique identifier
      - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
      - `city` string, nullable — The address city. **(required for shipment purchase)**
      - `federal_tax_id` string, nullable — The party frederal tax id
      - `state_tax_id` string, nullable — The party state id
      - `person_name` string, nullable — Attention to **(required for shipment purchase)**
      - `company_name` string, nullable — The company name if the party is a company
      - `country_code` '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', required — The address country code
      - `email` string, nullable — The party email
      - `phone_number` string, nullable — The party phone number.
      - `state_code` string, nullable — The address state code
      - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
      - `street_number` string, nullable — The address street number
      - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
      - `address_line2` string, nullable — The address line with suite number
      - `validate_location` boolean, nullable — Indicate if the address should be validated
      - `object_type` string — Specifies the object type
      - `validation` AddressValidation
        - `success` boolean, required — True if the address is valid
        - `meta` object, nullable — validation service details
    - `return_address` AddressData
      - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
      - `city` string, nullable — The address city. **(required for shipment purchase)**
      - `federal_tax_id` string, nullable — The party frederal tax id
      - `state_tax_id` string, nullable — The party state id
      - `person_name` string, nullable — Attention to **(required for shipment purchase)**
      - `company_name` string, nullable — The company name if the party is a company
      - `country_code` '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', required — The address country code
      - `email` string, nullable — The party email
      - `phone_number` string, nullable — The party phone number.
      - `state_code` string, nullable — The address state code
      - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
      - `street_number` string, nullable — The address street number
      - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
      - `address_line2` string, nullable — The address line with suite number
      - `validate_location` boolean, nullable — Indicate if the address should be validated
    - `billing_address` AddressData
      - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
      - `city` string, nullable — The address city. **(required for shipment purchase)**
      - `federal_tax_id` string, nullable — The party frederal tax id
      - `state_tax_id` string, nullable — The party state id
      - `person_name` string, nullable — Attention to **(required for shipment purchase)**
      - `company_name` string, nullable — The company name if the party is a company
      - `country_code` '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', required — The address country code
      - `email` string, nullable — The party email
      - `phone_number` string, nullable — The party phone number.
      - `state_code` string, nullable — The address state code
      - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
      - `street_number` string, nullable — The address street number
      - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
      - `address_line2` string, nullable — The address line with suite number
      - `validate_location` boolean, nullable — Indicate if the address should be validated
    - `parcels` Parcel[], required — The shipment's parcels
      - `id` string — A unique identifier
      - `weight` number, double, required — The parcel's weight
      - `width` number, double, nullable — The parcel's width
      - `height` number, double, nullable — The parcel's height
      - `length` number, double, nullable — The parcel's length
      - `packaging_type` string, nullable — The parcel's packaging type.<br/> **Note that the packaging is optional when using a package preset.**<br/> values: <br/> `envelope` `pak` `tube` `pallet` `small_box` `medium_box` `your_packaging`<br/> For carrier specific packaging types, please consult the reference.
      - `package_preset` string, nullable — The parcel's package preset.<br/> For carrier specific package presets, please consult the reference.
      - `description` string, nullable — The parcel's description
      - `content` string, nullable — The parcel's content description
      - `is_document` boolean, nullable — Indicates if the parcel is composed of documents only
      - `weight_unit` 'KG' | 'LB' | 'OZ' | 'G', required — The parcel's weight unit
      - `dimension_unit` 'CM' | 'IN' | 'null', nullable — The parcel's dimension unit
      - `items` Commodity[] — The parcel items.
        - `id` string — A unique identifier
        - `weight` number, double, required — The commodity's weight
        - `weight_unit` 'KG' | 'LB' | 'OZ' | 'G', required — The commodity's weight unit
        - `title` string, nullable — A description of the commodity
        - `description` string, nullable — A description of the commodity
        - `quantity` integer — The commodity's quantity (number or item)
        - `sku` string, nullable — The commodity's sku number
        - `hs_code` string, nullable — The commodity's hs_code number
        - `value_amount` number, double, nullable — The monetary value of the commodity
        - `value_currency` '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', nullable — The currency of the commodity value amount
        - `origin_country` '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', nullable — The origin or manufacture country
        - `parent_id` string, nullable — The id of the related order line item.
        - `metadata` object, nullable — <details> <summary>Commodity user references metadata.</summary> { "part_number": "5218487281", "reference1": "# ref 1", "reference2": "# ref 2", "reference3": "# ref 3", ... } </details>
        - `object_type` string — Specifies the object type
      - `reference_number` string, nullable — The parcel reference number.<br/> (can be used as tracking number for custom carriers)
      - `freight_class` string, nullable — The parcel's freight class for pallet and freight shipments.
      - `options` object — <details> <summary>Parcel specific options.</summary> { "insurance": "100.00", "insured_by": "carrier", } </details>
      - `object_type` string — Specifies the object type
    - `services` string[], nullable — The carriers services requested for the shipment.<br/> Please consult the reference for specific carriers services.<br/> **Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier.**
    - `options` object — <details> <summary>The options available for the shipment.</summary> { "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` Payment
      - `paid_by` 'sender' | 'recipient' | 'third_party' — The payor type
      - `currency` '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', nullable — The payment amount currency
      - `account_number` string, nullable — The payor account number
    - `customs` Customs
      - `id` string — A unique identifier
      - `commodities` Commodity[] — The parcel content items
        - `id` string — A unique identifier
        - `weight` number, double, required — The commodity's weight
        - `weight_unit` 'KG' | 'LB' | 'OZ' | 'G', required — The commodity's weight unit
        - `title` string, nullable — A description of the commodity
        - `description` string, nullable — A description of the commodity
        - `quantity` integer — The commodity's quantity (number or item)
        - `sku` string, nullable — The commodity's sku number
        - `hs_code` string, nullable — The commodity's hs_code number
        - `value_amount` number, double, nullable — The monetary value of the commodity
        - `value_currency` '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', nullable — The currency of the commodity value amount
        - `origin_country` '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', nullable — The origin or manufacture country
        - `parent_id` string, nullable — The id of the related order line item.
        - `metadata` object, nullable — <details> <summary>Commodity user references metadata.</summary> { "part_number": "5218487281", "reference1": "# ref 1", "reference2": "# ref 2", "reference3": "# ref 3", ... } </details>
        - `object_type` string — Specifies the object type
      - `duty` Duty
        - `paid_by` 'sender' | 'recipient' | 'third_party' | '' | 'null', nullable — The duty payer
        - `currency` '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', nullable — The declared value currency
        - `declared_value` number, double, nullable — The package declared value
        - `account_number` string, nullable — The duty payment account number
      - `duty_billing_address` Address
        - `id` string — A unique identifier
        - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
        - `city` string, nullable — The address city. **(required for shipment purchase)**
        - `federal_tax_id` string, nullable — The party frederal tax id
        - `state_tax_id` string, nullable — The party state id
        - `person_name` string, nullable — Attention to **(required for shipment purchase)**
        - `company_name` string, nullable — The company name if the party is a company
        - `country_code` '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', required — The address country code
        - `email` string, nullable — The party email
        - `phone_number` string, nullable — The party phone number.
        - `state_code` string, nullable — The address state code
        - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
        - `street_number` string, nullable — The address street number
        - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
        - `address_line2` string, nullable — The address line with suite number
        - `validate_location` boolean, nullable — Indicate if the address should be validated
        - `object_type` string — Specifies the object type
        - `validation` AddressValidation
          - `success` boolean, required — True if the address is valid
          - `meta` object, nullable — validation service details
      - `content_type` 'documents' | 'gift' | 'sample' | 'merchandise' | 'return_merchandise' | 'other' | '' | 'null', nullable
      - `content_description` string, nullable
      - `incoterm` 'CFR' | 'CIF' | 'CIP' | 'CPT' | 'DAP' | 'DAF' | 'DDP' | 'DDU' | 'DEQ' | 'DES' | 'EXW' | 'FAS' | 'FCA' | 'FOB' | 'null', nullable — The customs 'term of trade' also known as 'incoterm'
      - `invoice` string, nullable — The invoice reference number
      - `invoice_date` string, nullable — The invoice date.<br/> Date Format: `YYYY-MM-DD`
      - `commercial_invoice` boolean, nullable — Indicates if the shipment is commercial
      - `certify` boolean, nullable — Indicate that signer certified confirmed all
      - `signer` string, nullable
      - `options` object — <details> <summary>Customs identification options.</summary> { "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 — Specifies the object type
    - `rates` Rate[] — The list for shipment rates fetched previously
      - `id` string — A unique identifier
      - `object_type` string — Specifies the object type
      - `carrier_name` string, required — The rate's carrier
      - `carrier_id` string, required — The targeted carrier's name (unique identifier)
      - `currency` string — The rate monetary values currency code
      - `service` string, nullable — The carrier's rate (quote) service
      - `total_charge` number, double — The rate's monetary amount of the total charge.<br/> This is the gross amount of the rate after adding the additional charges
      - `transit_days` integer, nullable — The estimated delivery transit days
      - `extra_charges` Charge[] — list of the rate's additional charges
        - `name` string, nullable — The charge description
        - `amount` number, double, nullable — The charge monetary value
        - `currency` string, nullable — The charge amount currency
      - `estimated_delivery` string, nullable — The delivery estimated date
      - `meta` object, nullable — provider specific metadata
      - `test_mode` boolean, required — Specified whether it was created with a carrier in test mode
    - `reference` string, nullable — The shipment reference
    - `label_type` 'PDF' | 'ZPL' | 'PNG' | '' | 'null', nullable — The shipment label file type.
    - `carrier_ids` string[], nullable — The list of configured carriers you wish to get rates from.<br/> **Note that the request will be sent to all carriers in nothing is specified**
    - `tracker_id` string, nullable — The attached tracker id
    - `created_at` string, required — The shipment creation datetime.<br/> Date Format: `YYYY-MM-DD HH:MM:SS.mmmmmmz`
    - `metadata` object — User metadata for the shipment
    - `messages` Message[] — The list of note or warning messages
      - `message` string — The error or warning message
      - `code` string — The message code
      - `details` object — any additional details
      - `carrier_name` string — The targeted carrier
      - `carrier_id` string — The targeted carrier name (unique identifier)
    - `status` 'draft' | 'purchased' | 'cancelled' | 'shipped' | 'in_transit' | 'delivered' | 'needs_attention' | 'out_for_delivery' | 'delivery_failed' — The current Shipment status
    - `carrier_name` string, nullable — The shipment carrier
    - `carrier_id` string, nullable — The shipment carrier configured identifier
    - `tracking_number` string, nullable — The shipment tracking number
    - `shipment_identifier` string, nullable — The shipment carrier system identifier
    - `selected_rate` Rate
      - `id` string — A unique identifier
      - `object_type` string — Specifies the object type
      - `carrier_name` string, required — The rate's carrier
      - `carrier_id` string, required — The targeted carrier's name (unique identifier)
      - `currency` string — The rate monetary values currency code
      - `service` string, nullable — The carrier's rate (quote) service
      - `total_charge` number, double — The rate's monetary amount of the total charge.<br/> This is the gross amount of the rate after adding the additional charges
      - `transit_days` integer, nullable — The estimated delivery transit days
      - `extra_charges` Charge[] — list of the rate's additional charges
        - `name` string, nullable — The charge description
        - `amount` number, double, nullable — The charge monetary value
        - `currency` string, nullable — The charge amount currency
      - `estimated_delivery` string, nullable — The delivery estimated date
      - `meta` object, nullable — provider specific metadata
      - `test_mode` boolean, required — Specified whether it was created with a carrier in test mode
    - `meta` object, nullable — provider specific metadata
    - `service` string, nullable — The selected service
    - `selected_rate_id` string, nullable — The shipment selected rate.
    - `test_mode` boolean, required — Specified whether it was created with a carrier in test mode
    - `label_url` string, uri, nullable — The shipment label URL
    - `invoice_url` string, uri, nullable — The shipment invoice URL
  - `test_mode` boolean, required — Specify whether the order is in test mode or not.
  - `created_at` string, required — The shipment creation datetime.<br/> Date Format: `YYYY-MM-DD HH:MM:SS.mmmmmmz`

## Other responses

- `400`
- `404`
- `409`
- `500`

---

[API](https://skmtc.dev/karrio/apis/karrio-api.md) · [All operations](https://skmtc.dev/karrio/apis/karrio-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/karrio/karrio-api/revisions/76ab3b7c3a61/schema)