openapi: 3.2.0
info:
description: "\nKarrio is a multi-carrier shipping API that simplifies the integration of logistics carrier services.\n\nThe Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded\nrequest bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\nThe Karrio API differs for every account as we release new versions.\nThese docs are customized to your version of the API.\n\n\n## Versioning\n\nWhen backwards-incompatible changes are made to the API, a new, dated version is released.\nThe current version is `2026.1.32`.\n\nRead our API changelog to learn more about backwards compatibility.\n\nAs a precaution, use API versioning to check a new API version before committing to an upgrade.\n\n\n## Environments\n\nThe Karrio API offer the possibility to create and retrieve certain objects in `test_mode`.\nIn development, it is therefore possible to add carrier connections, get live rates,\nbuy labels, create trackers and schedule pickups in `test_mode`.\n\n\n## Pagination\n\nAll top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses,\nlist shipments, and list trackers. These list API methods share a common structure, taking at least these\ntwo parameters: limit, and offset.\n\nKarrio utilizes offset-based pagination via the offset and limit parameters.\nBoth parameters take a number as value (see below) and return objects in reverse chronological order.\nThe offset parameter returns objects listed after an index.\nThe limit parameter take a limit on the number of objects to be returned from 1 to 100.\n\n\n```json\n{\n \"count\": 100,\n \"next\": \"/v1/shipments?limit=25&offset=50\",\n \"previous\": \"/v1/shipments?limit=25&offset=25\",\n \"results\": [\n { ... },\n ]\n}\n```\n\n## Metadata\n\nUpdateable Karrio objects—including Shipment and Order have a metadata parameter.\nYou can use this parameter to attach key-value data to these Karrio objects.\n\nMetadata is useful for storing additional, structured information on an object.\nAs an example, you could store your user's full name and corresponding unique identifier\nfrom your system on a Karrio Order object.\n\nDo not store any sensitive information as metadata.\n\n## Authentication\n\nAPI keys are used to authenticate requests. You can view and manage your API keys in the Dashboard.\n\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret\nAPI keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n\nAuthentication to the API is performed via HTTP Basic Auth. Provide your API token as\nthe basic auth username value. You do not need to provide a password.\n\n```shell\n$ curl https://instance.api.com/v1/shipments \\\n -u key_xxxxxx:\n# The colon prevents curl from asking for a password.\n```\n\nIf you need to authenticate via bearer auth (e.g., for a cross-origin request),\nuse `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`.\n\nAll API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure).\nAPI requests without authentication will also fail.\n"
title: Karrio Orders API
version: 2026.1.32
tags:
- name: Orders
description: "This is an object representing your Karrio order.\n You can create Karrio orders to organize your shipments and ship line items separately.\n "
paths:
/v1/orders:
get:
operationId: '&&&&list'
description: Retrieve all orders.
summary: List all orders
tags:
- Orders
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: listOrders
post:
operationId: '&&&&create'
description: Create a new order object.
summary: Create an order
tags:
- Orders
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: createOrder
/v1/orders/{id}:
get:
operationId: '&&&&retrieve'
description: Retrieve an order.
summary: Retrieve an order
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Orders
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: retrieveOrder
put:
operationId: '&&&&update'
description: 'This operation allows for updating properties of an order including `options` and `metadata`.
It is not for editing the line items of an order.'
summary: Update an order
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Orders
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderUpdateData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: updateOrder
delete:
operationId: '&&&&dismiss'
description: Dismiss an order from fulfillment.
summary: Dismiss an order
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Orders
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
deprecated: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: dismissOrder
/v1/orders/{id}/cancel:
post:
operationId: '&&&&cancel'
description: 'Cancel an order.
``pk`` can be either the karrio order ID or a ``request_id``
stored in ``order.meta["request_id"]``.'
summary: Cancel an order
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Orders
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: cancelOrder
components:
schemas:
OrderData:
type: object
properties:
order_id:
type: string
description: The source' order id.
order_date:
type:
- string
- 'null'
description: 'The order date. format: `YYYY-MM-DD`'
source:
type: string
default: API
description: "The order's source.
\n e.g. API, POS, ERP, Shopify, Woocommerce, etc.\n "
shipping_to:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The customer or recipient address for the order.
shipping_from:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The origin or warehouse address of the order items.
billing_address:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The customer' or shipping billing address.
line_items:
type: array
items:
$ref: '#/components/schemas/CommodityData'
description: The order line items.
options:
type:
- object
- 'null'
additionalProperties: {}
description: "\n The options available for the order shipments.
\n\n {\n \"currency\": \"USD\",\n \"paid_by\": \"third_party\",\n \"payment_account_number\": \"123456789\",\n \"duty_paid_by\": \"third_party\",\n \"duty_account_number\": \"123456789\",\n \"invoice_number\": \"123456789\",\n \"invoice_date\": \"2020-01-01\",\n \"single_item_per_parcel\": true,\n \"carrier_ids\": [\"canadapost-test\"],\n \"preferred_service\": \"fedex_express_saver\",\n }\n \n "
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the order.
required:
- line_items
- order_id
- shipping_to
Parcel:
type: object
properties:
id:
type: string
description: A unique identifier
weight:
type: number
format: double
description: The parcel's weight
width:
type:
- number
- 'null'
format: double
description: The parcel's width
height:
type:
- number
- 'null'
format: double
description: The parcel's height
length:
type:
- number
- 'null'
format: double
description: The parcel's length
packaging_type:
type:
- string
- 'null'
description: "The parcel's packaging type.
\n **Note that the packaging is optional when using a package preset.**
\n values:
\n `envelope` `pak` `tube` `pallet` `small_box` `medium_box` `your_packaging`
\n For carrier specific packaging types, please consult the reference.\n "
maxLength: 100
package_preset:
type:
- string
- 'null'
description: "The parcel's package preset.
\n For carrier specific package presets, please consult the reference.\n "
maxLength: 100
description:
type:
- string
- 'null'
description: The parcel's description
maxLength: 250
content:
type:
- string
- 'null'
description: The parcel's content description
maxLength: 100
is_document:
type:
- boolean
- 'null'
default: false
description: Indicates if the parcel is composed of documents only
weight_unit:
enum:
- KG
- LB
- OZ
- G
type: string
x-spec-enum-id: 3a766910e8401666
description: The parcel's weight unit
dimension_unit:
enum:
- CM
- IN
- null
type:
- string
- 'null'
x-spec-enum-id: 41993cb8117c279c
description: The parcel's dimension unit
items:
type: array
items:
$ref: '#/components/schemas/Commodity'
description: The parcel items.
reference_number:
type:
- string
- 'null'
description: "The parcel reference number.
\n (can be used as tracking number for custom carriers)\n "
maxLength: 100
freight_class:
type:
- string
- 'null'
description: The parcel's freight class for pallet and freight shipments.
maxLength: 6
options:
type: object
additionalProperties: {}
default: {}
description: "\n Parcel specific options.
\n\n {\n \"insurance\": \"100.00\",\n \"insured_by\": \"carrier\",\n }\n \n "
meta:
type:
- object
- 'null'
additionalProperties: {}
description: "Template metadata for template identification.\n Structure: {\"label\": \"Standard Box\", \"is_default\": true}\n "
object_type:
type: string
default: parcel
description: Specifies the object type
required:
- weight
- weight_unit
Rate:
type: object
properties:
id:
type: string
description: A unique identifier
object_type:
type: string
default: rate
description: Specifies the object type
carrier_name:
type: string
description: The rate's carrier
carrier_id:
type: string
description: The targeted carrier's name (unique identifier)
currency:
type: string
description: The rate monetary values currency code
service:
type:
- string
- 'null'
description: The carrier's rate (quote) service
total_charge:
type: number
format: double
default: 0.0
description: "The rate's monetary amount of the total charge.
\n This is the gross amount of the rate after adding the additional charges\n "
transit_days:
type:
- integer
- 'null'
description: The estimated delivery transit days
extra_charges:
type: array
items:
$ref: '#/components/schemas/Charge'
default: []
description: list of the rate's additional charges
estimated_delivery:
type:
- string
- 'null'
description: The delivery estimated date
meta:
type:
- object
- 'null'
additionalProperties: {}
description: provider specific metadata
test_mode:
type: boolean
description: Specified whether it was created with a carrier in test mode
required:
- carrier_id
- carrier_name
- test_mode
CustomsData:
type: object
properties:
commodities:
type: array
items:
$ref: '#/components/schemas/CommodityData'
description: The parcel content items
duty:
allOf:
- $ref: '#/components/schemas/Duty'
description: "The payment details.
\n **Note that this is required for a Dutiable parcel shipped internationally.**\n "
duty_billing_address:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The duty payor address.
content_type:
enum:
- documents
- gift
- sample
- merchandise
- return_merchandise
- other
- ''
- null
type:
- string
- 'null'
x-spec-enum-id: b8935f22b570da75
content_description:
type:
- string
- 'null'
incoterm:
enum:
- CFR
- CIF
- CIP
- CPT
- DAP
- DAF
- DDP
- DDU
- DEQ
- DES
- EXW
- FAS
- FCA
- FOB
- null
type:
- string
- 'null'
x-spec-enum-id: 61b2121fbcca17a7
description: The customs 'term of trade' also known as 'incoterm'
invoice:
type:
- string
- 'null'
description: The invoice reference number
maxLength: 50
invoice_date:
type:
- string
- 'null'
description: "The invoice date.
\n Date Format: `YYYY-MM-DD`\n "
commercial_invoice:
type:
- boolean
- 'null'
description: Indicates if the shipment is commercial
certify:
type:
- boolean
- 'null'
description: Indicate that signer certified confirmed all
signer:
type:
- string
- 'null'
maxLength: 50
options:
type: object
additionalProperties: {}
default: {}
description: "\n Customs identification options.
\n\n {\n \"aes\": \"5218487281\",\n \"eel_pfc\": \"5218487281\",\n \"license_number\": \"5218487281\",\n \"certificate_number\": \"5218487281\",\n \"nip_number\": \"5218487281\",\n \"eori_number\": \"5218487281\",\n \"vat_registration_number\": \"5218487281\",\n }\n \n "
required:
- commodities
Shipment:
type: object
properties:
id:
type: string
description: A unique identifier
object_type:
type: string
default: shipment
description: Specifies the object type
tracking_url:
type:
- string
- 'null'
format: uri
description: The shipment tracking url
shipper:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the party.
\n Origin address (ship from) for the **shipper**
\n Destination address (ship to) for the **recipient**\n "
recipient:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the party.
\n Origin address (ship from) for the **shipper**
\n Destination address (ship to) for the **recipient**\n "
return_address:
allOf:
- $ref: '#/components/schemas/Address'
description: The return address for this shipment. Defaults to the shipper address.
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
description: The payor address.
parcels:
type: array
items:
$ref: '#/components/schemas/Parcel'
description: The shipment's parcels
services:
type:
- array
- 'null'
items:
type: string
default: []
description: "The carriers services requested for the shipment.
\n Please consult the reference for specific carriers services.
\n **Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier.**\n "
options:
type: object
additionalProperties: {}
default: {}
description: "\n The options available for the shipment.
\n\n {\n \"currency\": \"USD\",\n \"insurance\": 100.00,\n \"cash_on_delivery\": 30.00,\n \"dangerous_good\": true,\n \"declared_value\": 150.00,\n \"sms_notification\": true,\n \"email_notification\": true,\n \"email_notification_to\": \"shipper@mail.com\",\n \"hold_at_location\": true,\n \"paperless_trade\": true,\n \"preferred_service\": \"fedex_express_saver\",\n \"shipment_date\": \"2020-01-01\", # TODO: deprecate\n \"shipping_date\": \"2020-01-01T00:00\",\n \"shipment_note\": \"This is a shipment note\",\n \"signature_confirmation\": true,\n \"saturday_delivery\": true,\n \"shipper_instructions\": \"This is a shipper instruction\",\n \"recipient_instructions\": \"This is a recipient instruction\",\n \"doc_files\": [\n {\n \"doc_type\": \"commercial_invoice\",\n \"doc_file\": \"base64 encoded file\",\n \"doc_name\": \"commercial_invoice.pdf\",\n \"doc_format\": \"pdf\",\n }\n ],\n \"doc_references\": [\n {\n \"doc_id\": \"123456789\",\n \"doc_type\": \"commercial_invoice\",\n }\n ],\n }\n \n "
payment:
allOf:
- $ref: '#/components/schemas/Payment'
default:
paid_by: sender
currency: null
account_number: null
description: The payment details
customs:
allOf:
- $ref: '#/components/schemas/CustomsData'
description: "The customs details.
\n **Note that this is required for the shipment of an international Dutiable parcel.**\n "
rates:
type: array
items:
$ref: '#/components/schemas/Rate'
default: []
description: The list for shipment rates fetched previously
reference:
type:
- string
- 'null'
description: The shipment reference
order_id:
type:
- string
- 'null'
description: The order identifier associated with this shipment
label_type:
enum:
- PDF
- ZPL
- PNG
- ''
- null
type:
- string
- 'null'
x-spec-enum-id: 49b2c844813c9a67
description: The shipment label file type.
carrier_ids:
type:
- array
- 'null'
items:
type: string
default: []
description: "The list of configured carriers you wish to get rates from.
\n **Note that the request will be sent to all carriers in nothing is specified**\n "
tracker_id:
type:
- string
- 'null'
description: The attached tracker id
created_at:
type: string
description: "The shipment creation datetime.
\n Date Format: `YYYY-MM-DD HH:MM:SS.mmmmmmz`\n "
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the shipment
messages:
type: array
items:
$ref: '#/components/schemas/Message'
default: []
description: The list of note or warning messages
is_archived:
type: boolean
default: false
description: Indicates whether this shipment is archived.
archived_at:
type:
- string
- 'null'
description: Timestamp when the shipment was archived.
status:
enum:
- draft
- created
- cancelled
- shipped
- in_transit
- delivered
- needs_attention
- out_for_delivery
- delivery_failed
type: string
x-spec-enum-id: f4c394c6818de493
default: draft
description: The current Shipment status
carrier_name:
type:
- string
- 'null'
description: The shipment carrier
carrier_id:
type:
- string
- 'null'
description: The shipment carrier configured identifier
tracking_number:
type:
- string
- 'null'
description: The shipment tracking number
shipment_identifier:
type:
- string
- 'null'
description: The shipment carrier system identifier
selected_rate:
allOf:
- $ref: '#/components/schemas/Rate'
description: The shipment selected rate
meta:
type:
- object
- 'null'
additionalProperties: {}
description: provider specific metadata
return_shipment:
type:
- object
- 'null'
additionalProperties: {}
description: Return shipment details when a return label is provided with outbound shipment
service:
type:
- string
- 'null'
description: The selected service
selected_rate_id:
type:
- string
- 'null'
description: The shipment selected rate.
test_mode:
type: boolean
description: Specified whether it was created with a carrier in test mode
is_return:
type: boolean
default: false
description: Indicates whether this shipment is a return shipment.
label_url:
type:
- string
- 'null'
format: uri
description: The shipment label URL
invoice_url:
type:
- string
- 'null'
format: uri
description: The shipment invoice URL
shipping_documents:
type: array
items:
$ref: '#/components/schemas/ShippingDocument'
default: []
description: The list of shipping documents
required:
- created_at
- parcels
- recipient
- shipper
- test_mode
CommodityData:
type: object
properties:
weight:
type: number
format: double
description: The commodity's weight
weight_unit:
enum:
- KG
- LB
- OZ
- G
type: string
x-spec-enum-id: 3a766910e8401666
description: The commodity's weight unit
title:
type:
- string
- 'null'
description: A description of the commodity
maxLength: 200
description:
type:
- string
- 'null'
description: A description of the commodity
maxLength: 200
quantity:
type: integer
default: 1
description: The commodity's quantity (number or item)
sku:
type:
- string
- 'null'
description: The commodity's sku number
maxLength: 100
hs_code:
type:
- string
- 'null'
description: The commodity's hs_code number
maxLength: 100
value_amount:
type:
- number
- 'null'
format: double
description: The monetary value of the commodity
value_currency:
enum:
- 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
- RON
- 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
type:
- string
- 'null'
x-spec-enum-id: fd73376ae25ab80b
description: The currency of the commodity value amount
origin_country:
enum:
- 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
type:
- string
- 'null'
x-spec-enum-id: b4b44aee15c8daa0
description: The origin or manufacture country
product_url:
type:
- string
- 'null'
description: The product url
image_url:
type:
- string
- 'null'
description: The image url
product_id:
type:
- string
- 'null'
description: The product id
variant_id:
type:
- string
- 'null'
description: The variant id
parent_id:
type:
- string
- 'null'
description: The id of the related order line item.
metadata:
type:
- object
- 'null'
additionalProperties: {}
description: "\n Commodity user references metadata.
\n\n {\n \"part_number\": \"5218487281\",\n \"reference1\": \"# ref 1\",\n \"reference2\": \"# ref 2\",\n \"reference3\": \"# ref 3\",\n ...\n }\n \n "
meta:
type:
- object
- 'null'
additionalProperties: {}
description: "Template metadata for template identification.\n Structure: {\"label\": \"Widget Pro\", \"is_default\": false}\n "
required:
- weight
- weight_unit
Message:
type: object
properties:
message:
type: string
description: The error or warning message
code:
type: string
description: The message code
level:
type: string
description: The message level
details:
type: object
additionalProperties: {}
description: any additional details
carrier_name:
type: string
description: The targeted carrier
carrier_id:
type: string
description: The targeted carrier name (unique identifier)
AddressData:
type: object
properties:
id:
type:
- string
- 'null'
description: A unique identifier for the address (used in JSON embedded data)
postal_code:
type:
- string
- 'null'
description: "The address postal code\n **(required for shipment purchase)**\n "
maxLength: 20
city:
type:
- string
- 'null'
description: "The address city.\n **(required for shipment purchase)**\n "
maxLength: 50
federal_tax_id:
type:
- string
- 'null'
description: The party frederal tax id
maxLength: 50
state_tax_id:
type:
- string
- 'null'
description: The party state id
maxLength: 50
person_name:
type:
- string
- 'null'
description: "Attention to\n **(required for shipment purchase)**\n "
maxLength: 100
company_name:
type:
- string
- 'null'
description: The company name if the party is a company
maxLength: 100
country_code:
enum:
- 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
type: string
x-spec-enum-id: b4b44aee15c8daa0
description: The address country code
email:
type:
- string
- 'null'
description: The party email
phone_number:
type:
- string
- 'null'
description: The party phone number.
maxLength: 50
state_code:
type:
- string
- 'null'
description: The address state code
maxLength: 50
residential:
type:
- boolean
- 'null'
default: false
description: Indicate if the address is residential or commercial (enterprise)
street_number:
type:
- string
- 'null'
description: The address street number
maxLength: 100
address_line1:
type:
- string
- 'null'
description: "The address line with street number
\n **(required for shipment purchase)**\n "
maxLength: 100
address_line2:
type:
- string
- 'null'
description: The address line with suite number
maxLength: 100
validate_location:
type:
- boolean
- 'null'
default: false
description: Indicate if the address should be validated
meta:
type:
- object
- 'null'
additionalProperties: {}
description: "Template metadata for template identification.\n Structure: {\"label\": \"Warehouse A\", \"is_default\": true, \"usage\": [\"sender\", \"return\"]}\n "
required:
- country_code
Order:
type: object
properties:
id:
type: string
description: A unique identifier
object_type:
type: string
default: order
description: Specifies the object type
is_archived:
type: boolean
default: false
description: Indicates whether this order is archived.
archived_at:
type:
- string
- 'null'
description: Timestamp when the order was archived.
order_id:
type: string
description: The source' order id.
order_date:
type:
- string
- 'null'
description: 'The order date. format: `YYYY-MM-DD`'
source:
type: string
description: The order's source.
status:
enum:
- unfulfilled
- cancelled
- fulfilled
- delivered
- partial
type: string
x-spec-enum-id: 3f28be4b3ea42880
default: unfulfilled
description: The order status.
shipping_to:
allOf:
- $ref: '#/components/schemas/Address'
description: The customer address for the order.
shipping_from:
allOf:
- $ref: '#/components/schemas/Address'
description: The origin or warehouse address of the order items.
billing_address:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The customer' or shipping billing address.
line_items:
type: array
items:
$ref: '#/components/schemas/LineItem'
description: The order line items.
options:
type:
- object
- 'null'
additionalProperties: {}
description: "\n The options available for the order shipments.
\n\n {\n \"currency\": \"USD\",\n \"paid_by\": \"third_party\",\n \"payment_account_number\": \"123456789\",\n \"duty_paid_by\": \"third_party\",\n \"duty_account_number\": \"123456789\",\n \"invoice_number\": \"123456789\",\n \"invoice_date\": \"2020-01-01\",\n \"single_item_per_parcel\": true,\n \"carrier_ids\": [\"canadapost-test\"],\n \"preferred_service\": \"fedex_express_saver\",\n }\n \n "
meta:
type:
- object
- 'null'
additionalProperties: {}
description: system related metadata.
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the order.
shipments:
type: array
items:
$ref: '#/components/schemas/Shipment'
description: The shipments associated with the order.
test_mode:
type: boolean
description: Specify whether the order is in test mode or not.
created_at:
type: string
description: "The shipment creation datetime.
\n Date Format: `YYYY-MM-DD HH:MM:SS.mmmmmmz`\n "
required:
- created_at
- line_items
- order_id
- shipping_to
- test_mode
Duty:
type: object
properties:
paid_by:
enum:
- sender
- recipient
- third_party
- ''
- null
type:
- string
- 'null'
x-spec-enum-id: 26ff4db10d761aa1
description: The duty payer
currency:
enum:
- 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
- RON
- 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
type:
- string
- 'null'
x-spec-enum-id: fd73376ae25ab80b
description: The declared value currency
declared_value:
type:
- number
- 'null'
format: double
description: The package declared value
account_number:
type:
- string
- 'null'
description: The duty payment account number
ShippingDocument:
type: object
description: Serializer for shipping document download response.
properties:
category:
type: string
description: The document category (e.g., 'label', 'invoice', 'manifest')
format:
type: string
description: The document format (e.g., 'PDF', 'ZPL')
print_format:
type:
- string
- 'null'
description: The document print format (e.g., 'A4', '6x4', '8.5x11')
url:
type:
- string
- 'null'
description: The document URL
base64:
type:
- string
- 'null'
description: The document content encoded in base64
required:
- category
- format
Address:
type: object
properties:
id:
type: string
description: A unique identifier
postal_code:
type:
- string
- 'null'
description: "The address postal code\n **(required for shipment purchase)**\n "
maxLength: 20
city:
type:
- string
- 'null'
description: "The address city.\n **(required for shipment purchase)**\n "
maxLength: 50
federal_tax_id:
type:
- string
- 'null'
description: The party frederal tax id
maxLength: 50
state_tax_id:
type:
- string
- 'null'
description: The party state id
maxLength: 50
person_name:
type:
- string
- 'null'
description: "Attention to\n **(required for shipment purchase)**\n "
maxLength: 100
company_name:
type:
- string
- 'null'
description: The company name if the party is a company
maxLength: 100
country_code:
enum:
- 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
type: string
x-spec-enum-id: b4b44aee15c8daa0
description: The address country code
email:
type:
- string
- 'null'
description: The party email
phone_number:
type:
- string
- 'null'
description: The party phone number.
maxLength: 50
state_code:
type:
- string
- 'null'
description: The address state code
maxLength: 50
residential:
type:
- boolean
- 'null'
default: false
description: Indicate if the address is residential or commercial (enterprise)
street_number:
type:
- string
- 'null'
description: The address street number
maxLength: 100
address_line1:
type:
- string
- 'null'
description: "The address line with street number
\n **(required for shipment purchase)**\n "
maxLength: 100
address_line2:
type:
- string
- 'null'
description: The address line with suite number
maxLength: 100
validate_location:
type:
- boolean
- 'null'
default: false
description: Indicate if the address should be validated
meta:
type:
- object
- 'null'
additionalProperties: {}
description: "Template metadata for template identification.\n Structure: {\"label\": \"Warehouse A\", \"is_default\": true, \"usage\": [\"sender\", \"return\"]}\n "
object_type:
type: string
default: address
description: Specifies the object type
validation:
allOf:
- $ref: '#/components/schemas/AddressValidation'
description: Specify address validation result
required:
- country_code
ErrorResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/APIError'
description: The list of API errors
Commodity:
type: object
properties:
id:
type: string
description: A unique identifier
weight:
type: number
format: double
description: The commodity's weight
weight_unit:
enum:
- KG
- LB
- OZ
- G
type: string
x-spec-enum-id: 3a766910e8401666
description: The commodity's weight unit
title:
type:
- string
- 'null'
description: A description of the commodity
maxLength: 200
description:
type:
- string
- 'null'
description: A description of the commodity
maxLength: 200
quantity:
type: integer
default: 1
description: The commodity's quantity (number or item)
sku:
type:
- string
- 'null'
description: The commodity's sku number
maxLength: 100
hs_code:
type:
- string
- 'null'
description: The commodity's hs_code number
maxLength: 100
value_amount:
type:
- number
- 'null'
format: double
description: The monetary value of the commodity
value_currency:
enum:
- 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
- RON
- 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
type:
- string
- 'null'
x-spec-enum-id: fd73376ae25ab80b
description: The currency of the commodity value amount
origin_country:
enum:
- 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
type:
- string
- 'null'
x-spec-enum-id: b4b44aee15c8daa0
description: The origin or manufacture country
product_url:
type:
- string
- 'null'
description: The product url
image_url:
type:
- string
- 'null'
description: The image url
product_id:
type:
- string
- 'null'
description: The product id
variant_id:
type:
- string
- 'null'
description: The variant id
parent_id:
type:
- string
- 'null'
description: The id of the related order line item.
metadata:
type:
- object
- 'null'
additionalProperties: {}
description: "\n Commodity user references metadata.
\n\n {\n \"part_number\": \"5218487281\",\n \"reference1\": \"# ref 1\",\n \"reference2\": \"# ref 2\",\n \"reference3\": \"# ref 3\",\n ...\n }\n \n "
meta:
type:
- object
- 'null'
additionalProperties: {}
description: "Template metadata for template identification.\n Structure: {\"label\": \"Widget Pro\", \"is_default\": false}\n "
object_type:
type: string
default: commodity
description: Specifies the object type
required:
- weight
- weight_unit
OrderUpdateData:
type: object
properties:
options:
type:
- object
- 'null'
additionalProperties: {}
description: "\n The options available for the order shipments.
\n\n {\n \"currency\": \"USD\",\n \"paid_by\": \"third_party\",\n \"payment_account_number\": \"123456789\",\n \"duty_paid_by\": \"recipient\",\n \"duty_account_number\": \"123456789\",\n \"invoice_number\": \"123456789\",\n \"invoice_date\": \"2020-01-01\",\n \"single_item_per_parcel\": true,\n \"carrier_ids\": [\"canadapost-test\"],\n }\n \n "
metadata:
type: object
additionalProperties: {}
description: User metadata for the shipment
LineItem:
type: object
properties:
id:
type: string
description: A unique identifier
weight:
type: number
format: double
description: The commodity's weight
weight_unit:
enum:
- KG
- LB
- OZ
- G
type: string
x-spec-enum-id: 3a766910e8401666
description: The commodity's weight unit
title:
type:
- string
- 'null'
description: A description of the commodity
maxLength: 200
description:
type:
- string
- 'null'
description: A description of the commodity
maxLength: 200
quantity:
type: integer
default: 1
description: The commodity's quantity (number or item)
sku:
type:
- string
- 'null'
description: The commodity's sku number
maxLength: 100
hs_code:
type:
- string
- 'null'
description: The commodity's hs_code number
maxLength: 100
value_amount:
type:
- number
- 'null'
format: double
description: The monetary value of the commodity
value_currency:
enum:
- 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
- RON
- 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
type:
- string
- 'null'
x-spec-enum-id: fd73376ae25ab80b
description: The currency of the commodity value amount
origin_country:
enum:
- 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
type:
- string
- 'null'
x-spec-enum-id: b4b44aee15c8daa0
description: The origin or manufacture country
product_url:
type:
- string
- 'null'
description: The product url
image_url:
type:
- string
- 'null'
description: The image url
product_id:
type:
- string
- 'null'
description: The product id
variant_id:
type:
- string
- 'null'
description: The variant id
parent_id:
type:
- string
- 'null'
description: The id of the related order line item.
metadata:
type:
- object
- 'null'
additionalProperties: {}
description: "\n Commodity user references metadata.
\n\n {\n \"part_number\": \"5218487281\",\n \"reference1\": \"# ref 1\",\n \"reference2\": \"# ref 2\",\n \"reference3\": \"# ref 3\",\n ...\n }\n \n "
meta:
type:
- object
- 'null'
additionalProperties: {}
description: "Template metadata for template identification.\n Structure: {\"label\": \"Widget Pro\", \"is_default\": false}\n "
object_type:
type: string
default: commodity
description: Specifies the object type
unfulfilled_quantity:
type: integer
default: 0
required:
- weight
- weight_unit
AddressValidation:
type: object
properties:
success:
type: boolean
description: True if the address is valid
meta:
type:
- object
- 'null'
additionalProperties: {}
description: validation service details
required:
- success
Payment:
type: object
properties:
paid_by:
enum:
- sender
- recipient
- third_party
type: string
x-spec-enum-id: 26ff4db10d761aa1
default: sender
description: The payor type
currency:
enum:
- 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
- RON
- 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
type:
- string
- 'null'
x-spec-enum-id: fd73376ae25ab80b
description: The payment amount currency
account_number:
type:
- string
- 'null'
description: The payor account number
OrderList:
type: object
properties:
count:
type:
- integer
- 'null'
next:
type:
- string
- 'null'
format: uri
previous:
type:
- string
- 'null'
format: uri
results:
type: array
items:
$ref: '#/components/schemas/Order'
required:
- results
APIError:
type: object
properties:
message:
type: string
description: The error or warning message
code:
type: string
description: The message code
level:
type: string
description: The message level
details:
type: object
additionalProperties: {}
description: any additional details
Charge:
type: object
properties:
name:
type:
- string
- 'null'
description: The charge description
amount:
type:
- number
- 'null'
format: double
description: The charge monetary value
currency:
type:
- string
- 'null'
description: The charge amount currency
id:
type:
- string
- 'null'
description: A surcharge id
securitySchemes:
JWT:
in: header
type: apiKey
scheme: bearer
bearerFormat: JWT
name: Authorization
description: 'Authorization: Bearer xxx.xxx.xxx'
OAuth2:
type: oauth2
in: header
name: Authorization
flows:
authorizationCode:
authorizationUrl: /oauth/authorize/
tokenUrl: /oauth/token/
scopes:
read: Read access to Karrio data
write: Write access to Karrio data
openid: OpenID connect
description: 'Authorization: Bearer xxxxxxxx'
Token:
type: apiKey
in: header
name: Authorization
description: 'Authorization: Token key_xxxxxxxx'
TokenBasic:
type: http
scheme: basic
name: Authorization
description: '-u key_xxxxxxxx:'