openapi: 3.0.3
info:
description: |2
## API Reference
Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services.
The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded
request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The Karrio API differs for every account as we release new versions.
These docs are customized to your version of the API.
## Versioning
When backwards-incompatible changes are made to the API, a new, dated version is released.
The current version is `2023.3.4`.
Read our API changelog and to learn more about backwards compatibility.
As a precaution, use API versioning to check a new API version before committing to an upgrade.
## Environments
The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`.
In development, it is therefore possible to add carrier connections, get live rates,
buy labels, create trackers and schedule pickups in `test_mode`.
## Pagination
All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list addresses,
list shipments, and list trackers. These list API methods share a common structure, taking at least these
two parameters: limit, and offset.
Karrio utilizes offset-based pagination via the offset and limit parameters.
Both parameters take a number as value (see below) and return objects in reverse chronological order.
The offset parameter returns objects listed after an index.
The limit parameter take a limit on the number of objects to be returned from 1 to 100.
```json
{
"count": 100,
"next": "/v1/shipments?limit=25&offset=50",
"previous": "/v1/shipments?limit=25&offset=25",
"results": [
{ ... },
]
}
```
## Metadata
Updateable Karrio objects—including Shipment and Order—have a metadata parameter.
You can use this parameter to attach key-value data to these Karrio objects.
Metadata is useful for storing additional, structured information on an object.
As an example, you could store your user's full name and corresponding unique identifier
from your system on a Karrio Order object.
Do not store any sensitive information as metadata.
## Authentication
API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret
API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via HTTP Basic Auth. Provide your API token as
the basic auth username value. You do not need to provide a password.
```shell
$ curl https://instance.api.com/v1/shipments \
-u key_xxxxxx:
# The colon prevents curl from asking for a password.
```
If you need to authenticate via bearer auth (e.g., for a cross-origin request),
use `-H "Authorization: Token key_xxxxxx"` instead of `-u key_xxxxxx`.
All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure).
API requests without authentication will also fail.
title: Karrio API
version: 2023.3.4
paths:
/:
get:
operationId: '&&ping'
summary: Instance Metadata
tags:
- API
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: {}
examples:
Metadata:
value:
VERSION: ''
APP_NAME: ''
HOST: ''
ADMIN: ''
OPENAPI: ''
GRAPHQL: ''
AUDIT_LOGGING: true
ALLOW_SIGNUP: true
ALLOW_ADMIN_APPROVED_SIGNUP: true
ALLOW_MULTI_ACCOUNT: true
MULTI_ORGANIZATIONS: true
ORDERS_MANAGEMENT: true
APPS_MANAGEMENT: true
DOCUMENTS_MANAGEMENT: true
DATA_IMPORT_EXPORT: true
CUSTOM_CARRIER_DEFINITION: true
PERSIST_SDK_TRACING: true
ORDER_DATA_RETENTION: true
TRACKER_DATA_RETENTION: true
SHIPMENT_DATA_RETENTION: true
API_LOGS_DATA_RETENTION: true
ORG_LEVEL_BILLING: true
TENANT_LEVEL_BILLING: true
description: ''
/api/token:
post:
operationId: '&&authenticate'
description: Authenticate the user and return a token pair
summary: Obtain auth token pair
tags:
- API
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenObtainPair'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenPair'
description: ''
/api/token/refresh:
post:
operationId: '&&refresh_token'
description: Authenticate the user and return a token pair
summary: Refresh auth token
tags:
- API
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefresh'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenPair'
description: ''
/api/token/verified:
post:
operationId: '&&get_verified_token'
description: Get a verified JWT token pair by submitting a Two-Factor authentication
code.
summary: Get verified JWT token
tags:
- API
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifiedTokenObtainPair'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenPair'
description: ''
/api/token/verify:
post:
operationId: '&&verify_token'
description: Verify an existent authentication token
summary: Verify token
tags:
- API
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenVerify'
required: true
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: {}
description: ''
/v1/addresses:
get:
operationId: $list
description: Retrieve all addresses.
summary: List all addresses
tags:
- Addresses
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AddressList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $create
description: Create a new address.
summary: Create an address
tags:
- Addresses
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddressData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Address'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/addresses/{id}:
get:
operationId: $retrieve
description: Retrieve an address.
summary: Retrieve an address
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Addresses
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Address'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
patch:
operationId: $update
description: update an address.
summary: Update an address
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Addresses
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAddressData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Address'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
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: ''
delete:
operationId: $discard
description: Discard an address.
summary: Discard an address
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Addresses
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Address'
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: ''
/v1/batches/data/import:
post:
operationId: '&&&&$import_file'
description: |-
Import csv, xls and xlsx data files for: `Beta`
- trackers data
- orders data
- shipments data
- billing data (soon)
**This operation will return a batch operation that you can poll to follow
the import progression.**
summary: Import data files
parameters:
- in: query
name: data_file
schema:
type: string
format: binary
- in: query
name: data_template
schema:
type: string
description: "A data template slug to use for the import.
\n **When\
\ nothing is specified, the system default headers are expected.**\n \
\ "
- in: query
name: resource_type
schema:
type: string
enum:
- billing
- order
- shipment
- trackers
description: The type of the resource to import
tags:
- Batches
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
resource_type:
type: string
data_template:
type: string
data_file:
type: string
format: binary
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchOperation'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/batches/operations:
get:
operationId: '&&&&$list'
description: Retrieve all batch operations. `Beta`
summary: List all batch operations
tags:
- Batches
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchOperations'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/batches/operations/{id}:
get:
operationId: '&&&&$retrieve'
description: Retrieve a batch operation. `Beta`
summary: Retrieve a batch operation
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Batches
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchOperation'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/batches/orders:
post:
operationId: '&&&&$create_orders'
description: Create multiple orders in a single batch. `Beta`
summary: Create orders
tags:
- Batches
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchOrderData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchOperation'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/batches/shipments:
post:
operationId: '&&&&$create_shipments'
description: Create multiple shipments in a single batch. `Beta`
summary: Create shipments
tags:
- Batches
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchShipmentData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchOperation'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/batches/trackers:
post:
operationId: '&&&&$create_trackers'
description: Create multiple trackers in a single batch. `Beta`
summary: Create trackers
tags:
- Batches
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchTrackerData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchOperation'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/carriers:
get:
operationId: '&&list'
description: Returns the list of configured carriers
summary: List all carriers
parameters:
- in: query
name: active
schema:
type: boolean
- in: query
name: system_only
schema:
type: boolean
tags:
- Carriers
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierList'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/carriers/{carrier_name}/services:
get:
operationId: '&&get_services'
description: Retrieve a carrier's services
summary: Get carrier services
parameters:
- in: path
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
required: true
tags:
- Carriers
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: {}
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/customs_info:
get:
operationId: $$list
description: Retrieve all stored customs declarations.
summary: List all customs info
tags:
- Customs
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomsList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $$create
description: Create a new customs declaration.
summary: Create a customs info
tags:
- Customs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomsData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Customs'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/customs_info/{id}:
get:
operationId: $$retrieve
description: Retrieve customs declaration.
summary: Retrieve a customs info
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Customs
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Customs'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
patch:
operationId: $$update
description: modify an existing customs declaration.
summary: Update a customs info
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Customs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCustomsData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Customs'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
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: ''
delete:
operationId: $$discard
description: Discard a customs declaration.
summary: Discard a customs info
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Customs
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Customs'
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: ''
/v1/documents:
get:
operationId: $$$$$&list
description: Retrieve all shipping document upload records.
summary: List all upload records
parameters:
- in: query
name: created_after
schema:
type: string
format: date-time
- in: query
name: created_before
schema:
type: string
format: date-time
- in: query
name: shipment_id
schema:
type: string
tags:
- Documents
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUploadRecords'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $$$$$&upload
description: Upload a shipping document.
summary: Upload documents
tags:
- Documents
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUploadData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUploadRecord'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/documents/{id}:
get:
operationId: $$$$$&retrieve
description: Retrieve a shipping document upload record.
summary: Retrieve an upload record
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Documents
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUploadRecord'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/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: ''
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: ''
/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: ''
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: ''
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: ''
/v1/orders/{id}/cancel:
post:
operationId: '&&&&cancel'
description: Cancel an order.
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: ''
/v1/parcels:
get:
operationId: $$$list
description: Retrieve all stored parcels.
summary: List all parcels
tags:
- Parcels
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $$$create
description: Create a new parcel.
summary: Create a parcel
tags:
- Parcels
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/parcels/{id}:
get:
operationId: $$$retrieve
description: Retrieve a parcel.
summary: Retrieve a parcel
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Parcels
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
patch:
operationId: $$$update
description: modify an existing parcel's details.
summary: Update a parcel
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Parcels
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedParcelData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
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: ''
delete:
operationId: $$$discard
description: Remove a parcel.
summary: Remove a parcel
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Parcels
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
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: ''
/v1/pickups:
get:
operationId: $$$$list
description: Retrieve all scheduled pickups.
summary: List shipment pickups
tags:
- Pickups
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickupList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/pickups/{carrier_name}/schedule:
post:
operationId: $$$$schedule
description: Schedule a pickup for one or many shipments with labels already
purchased.
summary: Schedule a pickup
parameters:
- in: path
name: carrier_name
schema:
type: string
required: true
tags:
- Pickups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickupData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Pickup'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/pickups/{id}:
get:
operationId: $$$$retrieve
description: Retrieve a scheduled pickup.
summary: Retrieve a pickup
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Pickups
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Pickup'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $$$$update
description: Modify a pickup for one or many shipments with labels already purchased.
summary: Update a pickup
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Pickups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickupUpdateData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Pickup'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/pickups/{id}/cancel:
post:
operationId: $$$$cancel
description: Cancel a pickup of one or more shipments.
summary: Cancel a pickup
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Pickups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickupCancelData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Pickup'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/proxy/pickups/{carrier_name}:
post:
operationId: '@schedule_pickup'
description: Schedule one or many parcels pickup
summary: Schedule a pickup
parameters:
- in: path
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
required: true
tags:
- Proxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickupRequest'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickupResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/proxy/pickups/{carrier_name}/cancel:
post:
operationId: '@cancel_pickup'
description: Cancel a pickup previously scheduled
summary: Cancel a pickup
parameters:
- in: path
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
required: true
tags:
- Proxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickupCancelRequest'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperationResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/proxy/pickups/{carrier_name}/update:
post:
operationId: '@update_pickup'
description: Modify a scheduled pickup
summary: Update a pickup
parameters:
- in: path
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
required: true
tags:
- Proxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickupUpdateRequest'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickupResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/proxy/rates:
post:
operationId: '@@fetch_rates'
description: |2
The Shipping process begins by fetching rates for your shipment.
Use this service to fetch a shipping rates available.
summary: Fetch shipment rates
tags:
- Proxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RateRequest'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RateResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/proxy/shipping:
post:
operationId: '@@@buy_label'
description: |-
Once the shipping rates are retrieved, provide the required info to
submit the shipment by specifying your preferred rate.
summary: Buy a shipment label
tags:
- Proxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShippingRequest'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ShippingResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/proxy/shipping/{carrier_name}/cancel:
post:
operationId: '@@@void_label'
description: Cancel a shipment and the label previously created
summary: Void a shipment label
parameters:
- in: path
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
required: true
tags:
- Proxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentCancelRequest'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/OperationResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
/v1/proxy/tracking:
post:
operationId: '@@@@get_tracking'
description: You can track a shipment by specifying the carrier and the shipment
tracking number.
summary: Get tracking details
parameters:
- in: query
name: hub
schema:
type: string
tags:
- Proxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/proxy/tracking/{carrier_name}/{tracking_number}:
get:
operationId: '@@@@track_shipment'
description: You can track a shipment by specifying the carrier and the shipment
tracking number.
summary: Track a shipment
parameters:
- in: path
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- fedex
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
required: true
- in: query
name: hub
schema:
type: string
- in: path
name: tracking_number
schema:
type: string
required: true
tags:
- Proxy
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
deprecated: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/references:
get:
operationId: '&&data'
summary: Data References
tags:
- API
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: {}
examples:
References:
value:
VERSION: ''
APP_NAME: ''
HOST: ''
ADMIN: ''
OPENAPI: ''
GRAPHQL: ''
AUDIT_LOGGING: true
ALLOW_SIGNUP: true
ALLOW_ADMIN_APPROVED_SIGNUP: true
ALLOW_MULTI_ACCOUNT: true
MULTI_ORGANIZATIONS: true
ORDERS_MANAGEMENT: true
APPS_MANAGEMENT: true
DOCUMENTS_MANAGEMENT: true
DATA_IMPORT_EXPORT: true
CUSTOM_CARRIER_DEFINITION: true
PERSIST_SDK_TRACING: true
ORDER_DATA_RETENTION: true
TRACKER_DATA_RETENTION: true
SHIPMENT_DATA_RETENTION: true
API_LOGS_DATA_RETENTION: true
ORG_LEVEL_BILLING: true
TENANT_LEVEL_BILLING: true
ADDRESS_AUTO_COMPLETE: {}
countries: {}
currencies: {}
carriers: {}
customs_content_type: {}
incoterms: {}
states: {}
services: {}
service_names: {}
options: {}
option_names: {}
package_presets: {}
packaging_types: {}
payment_types: {}
carrier_capabilities: {}
service_levels: {}
description: ''
/v1/shipments:
get:
operationId: $$$$$list
description: Retrieve all shipments.
summary: List all shipments
parameters:
- in: query
name: address
schema:
type: string
- in: query
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
- in: query
name: created_after
schema:
type: string
format: date-time
- in: query
name: created_before
schema:
type: string
format: date-time
- in: query
name: keyword
schema:
type: string
- in: query
name: metadata_key
schema:
type: string
- in: query
name: metadata_value
schema:
type: string
- in: query
name: option_key
schema:
type: string
- in: query
name: option_value
schema:
type: string
- in: query
name: reference
schema:
type: string
- in: query
name: service
schema:
type: string
- in: query
name: status
schema:
type: string
enum:
- cancelled
- delivered
- draft
- in_transit
- purchased
- shipped
- in: query
name: tracking_number
schema:
type: string
tags:
- Shipments
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $$$$$create
description: Create a new shipment instance.
summary: Create a shipment
tags:
- Shipments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/shipments/{id}:
get:
operationId: $$$$$retrieve
description: Retrieve a shipment.
summary: Retrieve a shipment
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Shipments
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
put:
operationId: $$$$$update
description: |-
This operation allows for updating properties of a shipment including `label_type`, `reference`, `payment`, `options` and `metadata`.
It is not for editing the parcels of a shipment.
summary: Update a shipment
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Shipments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentUpdateData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
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: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/shipments/{id}/cancel:
post:
operationId: $$$$$cancel
description: Void a shipment with the associated label.
summary: Cancel a shipment
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Shipments
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
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: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/shipments/{id}/purchase:
post:
operationId: $$$$$purchase
description: Select your preferred rates to buy a shipment label.
summary: Buy a shipment label
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Shipments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentPurchaseData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
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: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/shipments/{id}/rates:
post:
operationId: $$$$$rates
description: Refresh the list of the shipment rates
summary: Fetch new shipment rates
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Shipments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentRateData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
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: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/trackers:
get:
operationId: $$$$$$list
description: Retrieve all shipment trackers.
summary: List all package trackers
parameters:
- in: query
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
- in: query
name: created_after
schema:
type: string
format: date-time
- in: query
name: created_before
schema:
type: string
format: date-time
- in: query
name: status
schema:
type: string
enum:
- delivered
- delivery_delayed
- delivery_failed
- in_transit
- on_hold
- out_for_delivery
- pending
- ready_for_pickup
- unknown
- in: query
name: tracking_number
schema:
type: string
tags:
- Trackers
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackerList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $$$$$$add
description: |-
This API creates or retrieves (if existent) a tracking status object containing the
details and events of a shipping in progress.
summary: Add a package tracker
parameters:
- in: query
name: hub
schema:
type: string
- in: query
name: pending_pickup
schema:
type: boolean
description: Add this flag to add the tracker whether the tracking info exist
or not.When the package is eventually picked up, the tracker with capture
real time updates.
tags:
- Trackers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingStatus'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/trackers/{carrier_name}/{tracking_number}:
get:
operationId: $$$$$$create
description: |-
This API creates or retrieves (if existent) a tracking status object containing the
details and events of a shipping in progress.
summary: Create a package tracker
parameters:
- in: path
name: carrier_name
schema:
type: string
required: true
- in: query
name: carrier_name
schema:
type: string
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- fedex
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
required: true
- in: query
name: hub
schema:
type: string
- in: path
name: tracking_number
schema:
type: string
required: true
tags:
- Trackers
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
deprecated: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingStatus'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'424':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/trackers/{id_or_tracking_number}:
get:
operationId: $$$$$$retrieves
description: Retrieve a package tracker
summary: Retrieves a package tracker
parameters:
- in: path
name: id_or_tracking_number
schema:
type: string
required: true
tags:
- Trackers
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingStatus'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
put:
operationId: $$$$$$update
description: Mixin to log requests
summary: Update tracker data
parameters:
- in: path
name: id_or_tracking_number
schema:
type: string
required: true
tags:
- Trackers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TrackerUpdateData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingStatus'
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: ''
delete:
operationId: $$$$$$remove
description: Discard a package tracker.
summary: Discard a package tracker
parameters:
- in: path
name: id_or_tracking_number
schema:
type: string
required: true
tags:
- Trackers
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingStatus'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/webhooks:
get:
operationId: $$$$$$$list
description: Retrieve all webhooks.
summary: List all webhooks
tags:
- Webhooks
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookList'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
post:
operationId: $$$$$$$create
description: Create a new webhook.
summary: Create a webhook
tags:
- Webhooks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookData'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/webhooks/{id}:
get:
operationId: $$$$$$$retrieve
description: Retrieve a webhook.
summary: Retrieve a webhook
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Webhooks
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
patch:
operationId: $$$$$$$update
description: update a webhook.
summary: Update a webhook
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Webhooks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWebhookData'
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
delete:
operationId: $$$$$$$remove
description: Remove a webhook.
summary: Remove a webhook
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Webhooks
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/v1/webhooks/{id}/test:
post:
operationId: $$$$$$$test
description: test a webhook.
summary: Test a webhook
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Webhooks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookTestRequest'
required: true
security:
- TokenBasic: []
- Token: []
- OAuth2: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
components:
schemas:
APIError:
type: object
properties:
message:
type: string
description: The error or warning message
code:
type: string
description: The message code
details:
type: object
additionalProperties: {}
description: any additional details
Address:
type: object
properties:
id:
type: string
description: A unique identifier
postal_code:
type: string
nullable: true
description: "The address postal code\n **(required for shipment\
\ purchase)**\n "
maxLength: 10
city:
type: string
nullable: true
description: "The address city.\n **(required for shipment purchase)**\n\
\ "
maxLength: 30
federal_tax_id:
type: string
nullable: true
description: The party frederal tax id
maxLength: 20
state_tax_id:
type: string
nullable: true
description: The party state id
maxLength: 20
person_name:
type: string
nullable: true
description: "Attention to\n **(required for shipment purchase)**\n\
\ "
maxLength: 30
company_name:
type: string
nullable: true
description: The company name if the party is a company
maxLength: 30
country_code:
enum:
- 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
type: string
description: |-
The address country code
* `AD` - AD
* `AE` - AE
* `AF` - AF
* `AG` - AG
* `AI` - AI
* `AL` - AL
* `AM` - AM
* `AN` - AN
* `AO` - AO
* `AR` - AR
* `AS` - AS
* `AT` - AT
* `AU` - AU
* `AW` - AW
* `AZ` - AZ
* `BA` - BA
* `BB` - BB
* `BD` - BD
* `BE` - BE
* `BF` - BF
* `BG` - BG
* `BH` - BH
* `BI` - BI
* `BJ` - BJ
* `BM` - BM
* `BN` - BN
* `BO` - BO
* `BR` - BR
* `BS` - BS
* `BT` - BT
* `BW` - BW
* `BY` - BY
* `BZ` - BZ
* `CA` - CA
* `CD` - CD
* `CF` - CF
* `CG` - CG
* `CH` - CH
* `CI` - CI
* `CK` - CK
* `CL` - CL
* `CM` - CM
* `CN` - CN
* `CO` - CO
* `CR` - CR
* `CU` - CU
* `CV` - CV
* `CY` - CY
* `CZ` - CZ
* `DE` - DE
* `DJ` - DJ
* `DK` - DK
* `DM` - DM
* `DO` - DO
* `DZ` - DZ
* `EC` - EC
* `EE` - EE
* `EG` - EG
* `ER` - ER
* `ES` - ES
* `ET` - ET
* `FI` - FI
* `FJ` - FJ
* `FK` - FK
* `FM` - FM
* `FO` - FO
* `FR` - FR
* `GA` - GA
* `GB` - GB
* `GD` - GD
* `GE` - GE
* `GF` - GF
* `GG` - GG
* `GH` - GH
* `GI` - GI
* `GL` - GL
* `GM` - GM
* `GN` - GN
* `GP` - GP
* `GQ` - GQ
* `GR` - GR
* `GT` - GT
* `GU` - GU
* `GW` - GW
* `GY` - GY
* `HK` - HK
* `HN` - HN
* `HR` - HR
* `HT` - HT
* `HU` - HU
* `IC` - IC
* `ID` - ID
* `IE` - IE
* `IL` - IL
* `IN` - IN
* `IQ` - IQ
* `IR` - IR
* `IS` - IS
* `IT` - IT
* `JE` - JE
* `JM` - JM
* `JO` - JO
* `JP` - JP
* `KE` - KE
* `KG` - KG
* `KH` - KH
* `KI` - KI
* `KM` - KM
* `KN` - KN
* `KP` - KP
* `KR` - KR
* `KV` - KV
* `KW` - KW
* `KY` - KY
* `KZ` - KZ
* `LA` - LA
* `LB` - LB
* `LC` - LC
* `LI` - LI
* `LK` - LK
* `LR` - LR
* `LS` - LS
* `LT` - LT
* `LU` - LU
* `LV` - LV
* `LY` - LY
* `MA` - MA
* `MC` - MC
* `MD` - MD
* `ME` - ME
* `MG` - MG
* `MH` - MH
* `MK` - MK
* `ML` - ML
* `MM` - MM
* `MN` - MN
* `MO` - MO
* `MP` - MP
* `MQ` - MQ
* `MR` - MR
* `MS` - MS
* `MT` - MT
* `MU` - MU
* `MV` - MV
* `MW` - MW
* `MX` - MX
* `MY` - MY
* `MZ` - MZ
* `NA` - NA
* `NC` - NC
* `NE` - NE
* `NG` - NG
* `NI` - NI
* `NL` - NL
* `NO` - NO
* `NP` - NP
* `NR` - NR
* `NU` - NU
* `NZ` - NZ
* `OM` - OM
* `PA` - PA
* `PE` - PE
* `PF` - PF
* `PG` - PG
* `PH` - PH
* `PK` - PK
* `PL` - PL
* `PR` - PR
* `PT` - PT
* `PW` - PW
* `PY` - PY
* `QA` - QA
* `RE` - RE
* `RO` - RO
* `RS` - RS
* `RU` - RU
* `RW` - RW
* `SA` - SA
* `SB` - SB
* `SC` - SC
* `SD` - SD
* `SE` - SE
* `SG` - SG
* `SH` - SH
* `SI` - SI
* `SK` - SK
* `SL` - SL
* `SM` - SM
* `SN` - SN
* `SO` - SO
* `SR` - SR
* `SS` - SS
* `ST` - ST
* `SV` - SV
* `SY` - SY
* `SZ` - SZ
* `TC` - TC
* `TD` - TD
* `TG` - TG
* `TH` - TH
* `TJ` - TJ
* `TL` - TL
* `TN` - TN
* `TO` - TO
* `TR` - TR
* `TT` - TT
* `TV` - TV
* `TW` - TW
* `TZ` - TZ
* `UA` - UA
* `UG` - UG
* `US` - US
* `UY` - UY
* `UZ` - UZ
* `VA` - VA
* `VC` - VC
* `VE` - VE
* `VG` - VG
* `VI` - VI
* `VN` - VN
* `VU` - VU
* `WS` - WS
* `XB` - XB
* `XC` - XC
* `XE` - XE
* `XM` - XM
* `XN` - XN
* `XS` - XS
* `XY` - XY
* `YE` - YE
* `YT` - YT
* `ZA` - ZA
* `ZM` - ZM
* `ZW` - ZW
email:
type: string
nullable: true
description: The party email
phone_number:
type: string
nullable: true
description: The party phone number.
maxLength: 20
state_code:
type: string
nullable: true
description: The address state code
maxLength: 20
suburb:
type: string
nullable: true
description: The address suburb if known
maxLength: 20
residential:
type: boolean
nullable: true
default: false
description: Indicate if the address is residential or commercial (enterprise)
street_number:
type: string
nullable: true
description: The address street number
maxLength: 20
address_line1:
type: string
nullable: true
description: "The address line with street number
\n **(required\
\ for shipment purchase)**\n "
maxLength: 50
address_line2:
type: string
nullable: true
description: The address line with suite number
maxLength: 50
validate_location:
type: boolean
nullable: true
default: false
description: Indicate if the address should be validated
object_type:
type: string
default: address
description: Specifies the object type
validation:
allOf:
- $ref: '#/components/schemas/AddressValidation'
nullable: true
description: Specify address validation result
required:
- country_code
AddressData:
type: object
properties:
postal_code:
type: string
nullable: true
description: "The address postal code\n **(required for shipment\
\ purchase)**\n "
maxLength: 10
city:
type: string
nullable: true
description: "The address city.\n **(required for shipment purchase)**\n\
\ "
maxLength: 30
federal_tax_id:
type: string
nullable: true
description: The party frederal tax id
maxLength: 20
state_tax_id:
type: string
nullable: true
description: The party state id
maxLength: 20
person_name:
type: string
nullable: true
description: "Attention to\n **(required for shipment purchase)**\n\
\ "
maxLength: 30
company_name:
type: string
nullable: true
description: The company name if the party is a company
maxLength: 30
country_code:
enum:
- 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
type: string
description: |-
The address country code
* `AD` - AD
* `AE` - AE
* `AF` - AF
* `AG` - AG
* `AI` - AI
* `AL` - AL
* `AM` - AM
* `AN` - AN
* `AO` - AO
* `AR` - AR
* `AS` - AS
* `AT` - AT
* `AU` - AU
* `AW` - AW
* `AZ` - AZ
* `BA` - BA
* `BB` - BB
* `BD` - BD
* `BE` - BE
* `BF` - BF
* `BG` - BG
* `BH` - BH
* `BI` - BI
* `BJ` - BJ
* `BM` - BM
* `BN` - BN
* `BO` - BO
* `BR` - BR
* `BS` - BS
* `BT` - BT
* `BW` - BW
* `BY` - BY
* `BZ` - BZ
* `CA` - CA
* `CD` - CD
* `CF` - CF
* `CG` - CG
* `CH` - CH
* `CI` - CI
* `CK` - CK
* `CL` - CL
* `CM` - CM
* `CN` - CN
* `CO` - CO
* `CR` - CR
* `CU` - CU
* `CV` - CV
* `CY` - CY
* `CZ` - CZ
* `DE` - DE
* `DJ` - DJ
* `DK` - DK
* `DM` - DM
* `DO` - DO
* `DZ` - DZ
* `EC` - EC
* `EE` - EE
* `EG` - EG
* `ER` - ER
* `ES` - ES
* `ET` - ET
* `FI` - FI
* `FJ` - FJ
* `FK` - FK
* `FM` - FM
* `FO` - FO
* `FR` - FR
* `GA` - GA
* `GB` - GB
* `GD` - GD
* `GE` - GE
* `GF` - GF
* `GG` - GG
* `GH` - GH
* `GI` - GI
* `GL` - GL
* `GM` - GM
* `GN` - GN
* `GP` - GP
* `GQ` - GQ
* `GR` - GR
* `GT` - GT
* `GU` - GU
* `GW` - GW
* `GY` - GY
* `HK` - HK
* `HN` - HN
* `HR` - HR
* `HT` - HT
* `HU` - HU
* `IC` - IC
* `ID` - ID
* `IE` - IE
* `IL` - IL
* `IN` - IN
* `IQ` - IQ
* `IR` - IR
* `IS` - IS
* `IT` - IT
* `JE` - JE
* `JM` - JM
* `JO` - JO
* `JP` - JP
* `KE` - KE
* `KG` - KG
* `KH` - KH
* `KI` - KI
* `KM` - KM
* `KN` - KN
* `KP` - KP
* `KR` - KR
* `KV` - KV
* `KW` - KW
* `KY` - KY
* `KZ` - KZ
* `LA` - LA
* `LB` - LB
* `LC` - LC
* `LI` - LI
* `LK` - LK
* `LR` - LR
* `LS` - LS
* `LT` - LT
* `LU` - LU
* `LV` - LV
* `LY` - LY
* `MA` - MA
* `MC` - MC
* `MD` - MD
* `ME` - ME
* `MG` - MG
* `MH` - MH
* `MK` - MK
* `ML` - ML
* `MM` - MM
* `MN` - MN
* `MO` - MO
* `MP` - MP
* `MQ` - MQ
* `MR` - MR
* `MS` - MS
* `MT` - MT
* `MU` - MU
* `MV` - MV
* `MW` - MW
* `MX` - MX
* `MY` - MY
* `MZ` - MZ
* `NA` - NA
* `NC` - NC
* `NE` - NE
* `NG` - NG
* `NI` - NI
* `NL` - NL
* `NO` - NO
* `NP` - NP
* `NR` - NR
* `NU` - NU
* `NZ` - NZ
* `OM` - OM
* `PA` - PA
* `PE` - PE
* `PF` - PF
* `PG` - PG
* `PH` - PH
* `PK` - PK
* `PL` - PL
* `PR` - PR
* `PT` - PT
* `PW` - PW
* `PY` - PY
* `QA` - QA
* `RE` - RE
* `RO` - RO
* `RS` - RS
* `RU` - RU
* `RW` - RW
* `SA` - SA
* `SB` - SB
* `SC` - SC
* `SD` - SD
* `SE` - SE
* `SG` - SG
* `SH` - SH
* `SI` - SI
* `SK` - SK
* `SL` - SL
* `SM` - SM
* `SN` - SN
* `SO` - SO
* `SR` - SR
* `SS` - SS
* `ST` - ST
* `SV` - SV
* `SY` - SY
* `SZ` - SZ
* `TC` - TC
* `TD` - TD
* `TG` - TG
* `TH` - TH
* `TJ` - TJ
* `TL` - TL
* `TN` - TN
* `TO` - TO
* `TR` - TR
* `TT` - TT
* `TV` - TV
* `TW` - TW
* `TZ` - TZ
* `UA` - UA
* `UG` - UG
* `US` - US
* `UY` - UY
* `UZ` - UZ
* `VA` - VA
* `VC` - VC
* `VE` - VE
* `VG` - VG
* `VI` - VI
* `VN` - VN
* `VU` - VU
* `WS` - WS
* `XB` - XB
* `XC` - XC
* `XE` - XE
* `XM` - XM
* `XN` - XN
* `XS` - XS
* `XY` - XY
* `YE` - YE
* `YT` - YT
* `ZA` - ZA
* `ZM` - ZM
* `ZW` - ZW
email:
type: string
nullable: true
description: The party email
phone_number:
type: string
nullable: true
description: The party phone number.
maxLength: 20
state_code:
type: string
nullable: true
description: The address state code
maxLength: 20
suburb:
type: string
nullable: true
description: The address suburb if known
maxLength: 20
residential:
type: boolean
nullable: true
default: false
description: Indicate if the address is residential or commercial (enterprise)
street_number:
type: string
nullable: true
description: The address street number
maxLength: 20
address_line1:
type: string
nullable: true
description: "The address line with street number
\n **(required\
\ for shipment purchase)**\n "
maxLength: 50
address_line2:
type: string
nullable: true
description: The address line with suite number
maxLength: 50
validate_location:
type: boolean
nullable: true
default: false
description: Indicate if the address should be validated
required:
- country_code
AddressList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Address'
required:
- results
AddressValidation:
type: object
properties:
success:
type: boolean
description: True if the address is valid
meta:
type: object
additionalProperties: {}
nullable: true
description: validation service details
required:
- success
BatchObject:
type: object
properties:
id:
type: string
description: A unique identifier
status:
enum:
- queued
- running
- failed
- completed
- completed_with_errors
type: string
description: |-
The batch operation resource status
* `queued` - queued
* `running` - running
* `failed` - failed
* `completed` - completed
* `completed_with_errors` - completed_with_errors
errors:
type: object
additionalProperties: {}
nullable: true
description: Resource processing errors
required:
- status
BatchOperation:
type: object
properties:
id:
type: string
description: A unique identifier
status:
enum:
- queued
- running
- failed
- completed
- completed_with_errors
type: string
description: |-
* `queued` - queued
* `running` - running
* `failed` - failed
* `completed` - completed
* `completed_with_errors` - completed_with_errors
resource_type:
enum:
- orders
- shipments
- trackers
- billing
type: string
description: |-
* `orders` - orders
* `shipments` - shipments
* `trackers` - trackers
* `billing` - billing
resources:
type: array
items:
$ref: '#/components/schemas/BatchObject'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
test_mode:
type: boolean
required:
- created_at
- resource_type
- resources
- status
- test_mode
- updated_at
BatchOperations:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/BatchOperation'
required:
- results
BatchOrderData:
type: object
properties:
orders:
type: array
items:
$ref: '#/components/schemas/OrderData'
description: The list of orders to process.
required:
- orders
BatchShipmentData:
type: object
properties:
shipments:
type: array
items:
$ref: '#/components/schemas/ShipmentData'
description: The list of shipments to process.
required:
- shipments
BatchTrackerData:
type: object
properties:
trackers:
type: array
items:
$ref: '#/components/schemas/TrackingData'
description: The list of tracking info to process.
required:
- trackers
CarrierList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/CarrierSettings'
required:
- results
CarrierSettings:
type: object
properties:
id:
type: string
description: A unique address identifier
object_type:
type: string
default: carrier
description: Specifies the object type
carrier_id:
type: string
description: Indicates a specific carrier configuration name.
carrier_name:
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- eshipper
- fedex
- freightcom
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
type: string
description: |-
Indicates a carrier (type)
* `amazon_mws` - amazon_mws
* `aramex` - aramex
* `australiapost` - australiapost
* `canadapost` - canadapost
* `canpar` - canpar
* `chronopost` - chronopost
* `dhl_express` - dhl_express
* `dhl_poland` - dhl_poland
* `dhl_universal` - dhl_universal
* `dicom` - dicom
* `dpd` - dpd
* `dpdhl` - dpdhl
* `easypost` - easypost
* `eshipper` - eshipper
* `fedex` - fedex
* `freightcom` - freightcom
* `generic` - generic
* `purolator` - purolator
* `royalmail` - royalmail
* `sendle` - sendle
* `sf_express` - sf_express
* `tnt` - tnt
* `ups` - ups
* `ups_freight` - ups_freight
* `usps` - usps
* `usps_international` - usps_international
* `yanwen` - yanwen
* `yunexpress` - yunexpress
display_name:
type: string
description: The carrier verbose name.
test_mode:
type: boolean
description: The test flag indicates whether to use a carrier configured
for test.
active:
type: boolean
description: The active flag indicates whether the carrier account is active
or not.
capabilities:
type: array
items:
type: string
nullable: true
description: The carrier supported and enabled capabilities.
required:
- active
- carrier_id
- carrier_name
- id
- test_mode
Charge:
type: object
properties:
name:
type: string
nullable: true
description: The charge description
amount:
type: number
format: double
nullable: true
description: The charge monetary value
currency:
type: string
nullable: true
description: The charge amount currency
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
type: string
description: |-
The commodity's weight unit
* `KG` - KG
* `LB` - LB
title:
type: string
nullable: true
description: A description of the commodity
maxLength: 35
description:
type: string
nullable: true
description: A description of the commodity
maxLength: 100
quantity:
type: integer
default: 1
description: The commodity's quantity (number or item)
sku:
type: string
nullable: true
description: The commodity's sku number
maxLength: 35
hs_code:
type: string
nullable: true
description: The commodity's hs_code number
maxLength: 35
value_amount:
type: number
format: double
nullable: true
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
- 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
nullable: true
description: |-
The currency of the commodity value amount
* `EUR` - EUR
* `AED` - AED
* `USD` - USD
* `XCD` - XCD
* `AMD` - AMD
* `ANG` - ANG
* `AOA` - AOA
* `ARS` - ARS
* `AUD` - AUD
* `AWG` - AWG
* `AZN` - AZN
* `BAM` - BAM
* `BBD` - BBD
* `BDT` - BDT
* `XOF` - XOF
* `BGN` - BGN
* `BHD` - BHD
* `BIF` - BIF
* `BMD` - BMD
* `BND` - BND
* `BOB` - BOB
* `BRL` - BRL
* `BSD` - BSD
* `BTN` - BTN
* `BWP` - BWP
* `BYN` - BYN
* `BZD` - BZD
* `CAD` - CAD
* `CDF` - CDF
* `XAF` - XAF
* `CHF` - CHF
* `NZD` - NZD
* `CLP` - CLP
* `CNY` - CNY
* `COP` - COP
* `CRC` - CRC
* `CUC` - CUC
* `CVE` - CVE
* `CZK` - CZK
* `DJF` - DJF
* `DKK` - DKK
* `DOP` - DOP
* `DZD` - DZD
* `EGP` - EGP
* `ERN` - ERN
* `ETB` - ETB
* `FJD` - FJD
* `GBP` - GBP
* `GEL` - GEL
* `GHS` - GHS
* `GMD` - GMD
* `GNF` - GNF
* `GTQ` - GTQ
* `GYD` - GYD
* `HKD` - HKD
* `HNL` - HNL
* `HRK` - HRK
* `HTG` - HTG
* `HUF` - HUF
* `IDR` - IDR
* `ILS` - ILS
* `INR` - INR
* `IRR` - IRR
* `ISK` - ISK
* `JMD` - JMD
* `JOD` - JOD
* `JPY` - JPY
* `KES` - KES
* `KGS` - KGS
* `KHR` - KHR
* `KMF` - KMF
* `KPW` - KPW
* `KRW` - KRW
* `KWD` - KWD
* `KYD` - KYD
* `KZT` - KZT
* `LAK` - LAK
* `LKR` - LKR
* `LRD` - LRD
* `LSL` - LSL
* `LYD` - LYD
* `MAD` - MAD
* `MDL` - MDL
* `MGA` - MGA
* `MKD` - MKD
* `MMK` - MMK
* `MNT` - MNT
* `MOP` - MOP
* `MRO` - MRO
* `MUR` - MUR
* `MVR` - MVR
* `MWK` - MWK
* `MXN` - MXN
* `MYR` - MYR
* `MZN` - MZN
* `NAD` - NAD
* `XPF` - XPF
* `NGN` - NGN
* `NIO` - NIO
* `NOK` - NOK
* `NPR` - NPR
* `OMR` - OMR
* `PEN` - PEN
* `PGK` - PGK
* `PHP` - PHP
* `PKR` - PKR
* `PLN` - PLN
* `PYG` - PYG
* `QAR` - QAR
* `RSD` - RSD
* `RUB` - RUB
* `RWF` - RWF
* `SAR` - SAR
* `SBD` - SBD
* `SCR` - SCR
* `SDG` - SDG
* `SEK` - SEK
* `SGD` - SGD
* `SHP` - SHP
* `SLL` - SLL
* `SOS` - SOS
* `SRD` - SRD
* `SSP` - SSP
* `STD` - STD
* `SYP` - SYP
* `SZL` - SZL
* `THB` - THB
* `TJS` - TJS
* `TND` - TND
* `TOP` - TOP
* `TRY` - TRY
* `TTD` - TTD
* `TWD` - TWD
* `TZS` - TZS
* `UAH` - UAH
* `UYU` - UYU
* `UZS` - UZS
* `VEF` - VEF
* `VND` - VND
* `VUV` - VUV
* `WST` - WST
* `YER` - YER
* `ZAR` - ZAR
origin_country:
enum:
- 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
- null
type: string
nullable: true
description: |-
The origin or manufacture country
* `AD` - AD
* `AE` - AE
* `AF` - AF
* `AG` - AG
* `AI` - AI
* `AL` - AL
* `AM` - AM
* `AN` - AN
* `AO` - AO
* `AR` - AR
* `AS` - AS
* `AT` - AT
* `AU` - AU
* `AW` - AW
* `AZ` - AZ
* `BA` - BA
* `BB` - BB
* `BD` - BD
* `BE` - BE
* `BF` - BF
* `BG` - BG
* `BH` - BH
* `BI` - BI
* `BJ` - BJ
* `BM` - BM
* `BN` - BN
* `BO` - BO
* `BR` - BR
* `BS` - BS
* `BT` - BT
* `BW` - BW
* `BY` - BY
* `BZ` - BZ
* `CA` - CA
* `CD` - CD
* `CF` - CF
* `CG` - CG
* `CH` - CH
* `CI` - CI
* `CK` - CK
* `CL` - CL
* `CM` - CM
* `CN` - CN
* `CO` - CO
* `CR` - CR
* `CU` - CU
* `CV` - CV
* `CY` - CY
* `CZ` - CZ
* `DE` - DE
* `DJ` - DJ
* `DK` - DK
* `DM` - DM
* `DO` - DO
* `DZ` - DZ
* `EC` - EC
* `EE` - EE
* `EG` - EG
* `ER` - ER
* `ES` - ES
* `ET` - ET
* `FI` - FI
* `FJ` - FJ
* `FK` - FK
* `FM` - FM
* `FO` - FO
* `FR` - FR
* `GA` - GA
* `GB` - GB
* `GD` - GD
* `GE` - GE
* `GF` - GF
* `GG` - GG
* `GH` - GH
* `GI` - GI
* `GL` - GL
* `GM` - GM
* `GN` - GN
* `GP` - GP
* `GQ` - GQ
* `GR` - GR
* `GT` - GT
* `GU` - GU
* `GW` - GW
* `GY` - GY
* `HK` - HK
* `HN` - HN
* `HR` - HR
* `HT` - HT
* `HU` - HU
* `IC` - IC
* `ID` - ID
* `IE` - IE
* `IL` - IL
* `IN` - IN
* `IQ` - IQ
* `IR` - IR
* `IS` - IS
* `IT` - IT
* `JE` - JE
* `JM` - JM
* `JO` - JO
* `JP` - JP
* `KE` - KE
* `KG` - KG
* `KH` - KH
* `KI` - KI
* `KM` - KM
* `KN` - KN
* `KP` - KP
* `KR` - KR
* `KV` - KV
* `KW` - KW
* `KY` - KY
* `KZ` - KZ
* `LA` - LA
* `LB` - LB
* `LC` - LC
* `LI` - LI
* `LK` - LK
* `LR` - LR
* `LS` - LS
* `LT` - LT
* `LU` - LU
* `LV` - LV
* `LY` - LY
* `MA` - MA
* `MC` - MC
* `MD` - MD
* `ME` - ME
* `MG` - MG
* `MH` - MH
* `MK` - MK
* `ML` - ML
* `MM` - MM
* `MN` - MN
* `MO` - MO
* `MP` - MP
* `MQ` - MQ
* `MR` - MR
* `MS` - MS
* `MT` - MT
* `MU` - MU
* `MV` - MV
* `MW` - MW
* `MX` - MX
* `MY` - MY
* `MZ` - MZ
* `NA` - NA
* `NC` - NC
* `NE` - NE
* `NG` - NG
* `NI` - NI
* `NL` - NL
* `NO` - NO
* `NP` - NP
* `NR` - NR
* `NU` - NU
* `NZ` - NZ
* `OM` - OM
* `PA` - PA
* `PE` - PE
* `PF` - PF
* `PG` - PG
* `PH` - PH
* `PK` - PK
* `PL` - PL
* `PR` - PR
* `PT` - PT
* `PW` - PW
* `PY` - PY
* `QA` - QA
* `RE` - RE
* `RO` - RO
* `RS` - RS
* `RU` - RU
* `RW` - RW
* `SA` - SA
* `SB` - SB
* `SC` - SC
* `SD` - SD
* `SE` - SE
* `SG` - SG
* `SH` - SH
* `SI` - SI
* `SK` - SK
* `SL` - SL
* `SM` - SM
* `SN` - SN
* `SO` - SO
* `SR` - SR
* `SS` - SS
* `ST` - ST
* `SV` - SV
* `SY` - SY
* `SZ` - SZ
* `TC` - TC
* `TD` - TD
* `TG` - TG
* `TH` - TH
* `TJ` - TJ
* `TL` - TL
* `TN` - TN
* `TO` - TO
* `TR` - TR
* `TT` - TT
* `TV` - TV
* `TW` - TW
* `TZ` - TZ
* `UA` - UA
* `UG` - UG
* `US` - US
* `UY` - UY
* `UZ` - UZ
* `VA` - VA
* `VC` - VC
* `VE` - VE
* `VG` - VG
* `VI` - VI
* `VN` - VN
* `VU` - VU
* `WS` - WS
* `XB` - XB
* `XC` - XC
* `XE` - XE
* `XM` - XM
* `XN` - XN
* `XS` - XS
* `XY` - XY
* `YE` - YE
* `YT` - YT
* `ZA` - ZA
* `ZM` - ZM
* `ZW` - ZW
parent_id:
type: string
nullable: true
description: The id of the related order line item.
metadata:
type: object
additionalProperties: {}
nullable: true
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 "
object_type:
type: string
default: commodity
description: Specifies the object type
required:
- weight
- weight_unit
CommodityData:
type: object
properties:
weight:
type: number
format: double
description: The commodity's weight
weight_unit:
enum:
- KG
- LB
type: string
description: |-
The commodity's weight unit
* `KG` - KG
* `LB` - LB
title:
type: string
nullable: true
description: A description of the commodity
maxLength: 35
description:
type: string
nullable: true
description: A description of the commodity
maxLength: 100
quantity:
type: integer
default: 1
description: The commodity's quantity (number or item)
sku:
type: string
nullable: true
description: The commodity's sku number
maxLength: 35
hs_code:
type: string
nullable: true
description: The commodity's hs_code number
maxLength: 35
value_amount:
type: number
format: double
nullable: true
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
- 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
nullable: true
description: |-
The currency of the commodity value amount
* `EUR` - EUR
* `AED` - AED
* `USD` - USD
* `XCD` - XCD
* `AMD` - AMD
* `ANG` - ANG
* `AOA` - AOA
* `ARS` - ARS
* `AUD` - AUD
* `AWG` - AWG
* `AZN` - AZN
* `BAM` - BAM
* `BBD` - BBD
* `BDT` - BDT
* `XOF` - XOF
* `BGN` - BGN
* `BHD` - BHD
* `BIF` - BIF
* `BMD` - BMD
* `BND` - BND
* `BOB` - BOB
* `BRL` - BRL
* `BSD` - BSD
* `BTN` - BTN
* `BWP` - BWP
* `BYN` - BYN
* `BZD` - BZD
* `CAD` - CAD
* `CDF` - CDF
* `XAF` - XAF
* `CHF` - CHF
* `NZD` - NZD
* `CLP` - CLP
* `CNY` - CNY
* `COP` - COP
* `CRC` - CRC
* `CUC` - CUC
* `CVE` - CVE
* `CZK` - CZK
* `DJF` - DJF
* `DKK` - DKK
* `DOP` - DOP
* `DZD` - DZD
* `EGP` - EGP
* `ERN` - ERN
* `ETB` - ETB
* `FJD` - FJD
* `GBP` - GBP
* `GEL` - GEL
* `GHS` - GHS
* `GMD` - GMD
* `GNF` - GNF
* `GTQ` - GTQ
* `GYD` - GYD
* `HKD` - HKD
* `HNL` - HNL
* `HRK` - HRK
* `HTG` - HTG
* `HUF` - HUF
* `IDR` - IDR
* `ILS` - ILS
* `INR` - INR
* `IRR` - IRR
* `ISK` - ISK
* `JMD` - JMD
* `JOD` - JOD
* `JPY` - JPY
* `KES` - KES
* `KGS` - KGS
* `KHR` - KHR
* `KMF` - KMF
* `KPW` - KPW
* `KRW` - KRW
* `KWD` - KWD
* `KYD` - KYD
* `KZT` - KZT
* `LAK` - LAK
* `LKR` - LKR
* `LRD` - LRD
* `LSL` - LSL
* `LYD` - LYD
* `MAD` - MAD
* `MDL` - MDL
* `MGA` - MGA
* `MKD` - MKD
* `MMK` - MMK
* `MNT` - MNT
* `MOP` - MOP
* `MRO` - MRO
* `MUR` - MUR
* `MVR` - MVR
* `MWK` - MWK
* `MXN` - MXN
* `MYR` - MYR
* `MZN` - MZN
* `NAD` - NAD
* `XPF` - XPF
* `NGN` - NGN
* `NIO` - NIO
* `NOK` - NOK
* `NPR` - NPR
* `OMR` - OMR
* `PEN` - PEN
* `PGK` - PGK
* `PHP` - PHP
* `PKR` - PKR
* `PLN` - PLN
* `PYG` - PYG
* `QAR` - QAR
* `RSD` - RSD
* `RUB` - RUB
* `RWF` - RWF
* `SAR` - SAR
* `SBD` - SBD
* `SCR` - SCR
* `SDG` - SDG
* `SEK` - SEK
* `SGD` - SGD
* `SHP` - SHP
* `SLL` - SLL
* `SOS` - SOS
* `SRD` - SRD
* `SSP` - SSP
* `STD` - STD
* `SYP` - SYP
* `SZL` - SZL
* `THB` - THB
* `TJS` - TJS
* `TND` - TND
* `TOP` - TOP
* `TRY` - TRY
* `TTD` - TTD
* `TWD` - TWD
* `TZS` - TZS
* `UAH` - UAH
* `UYU` - UYU
* `UZS` - UZS
* `VEF` - VEF
* `VND` - VND
* `VUV` - VUV
* `WST` - WST
* `YER` - YER
* `ZAR` - ZAR
origin_country:
enum:
- 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
- null
type: string
nullable: true
description: |-
The origin or manufacture country
* `AD` - AD
* `AE` - AE
* `AF` - AF
* `AG` - AG
* `AI` - AI
* `AL` - AL
* `AM` - AM
* `AN` - AN
* `AO` - AO
* `AR` - AR
* `AS` - AS
* `AT` - AT
* `AU` - AU
* `AW` - AW
* `AZ` - AZ
* `BA` - BA
* `BB` - BB
* `BD` - BD
* `BE` - BE
* `BF` - BF
* `BG` - BG
* `BH` - BH
* `BI` - BI
* `BJ` - BJ
* `BM` - BM
* `BN` - BN
* `BO` - BO
* `BR` - BR
* `BS` - BS
* `BT` - BT
* `BW` - BW
* `BY` - BY
* `BZ` - BZ
* `CA` - CA
* `CD` - CD
* `CF` - CF
* `CG` - CG
* `CH` - CH
* `CI` - CI
* `CK` - CK
* `CL` - CL
* `CM` - CM
* `CN` - CN
* `CO` - CO
* `CR` - CR
* `CU` - CU
* `CV` - CV
* `CY` - CY
* `CZ` - CZ
* `DE` - DE
* `DJ` - DJ
* `DK` - DK
* `DM` - DM
* `DO` - DO
* `DZ` - DZ
* `EC` - EC
* `EE` - EE
* `EG` - EG
* `ER` - ER
* `ES` - ES
* `ET` - ET
* `FI` - FI
* `FJ` - FJ
* `FK` - FK
* `FM` - FM
* `FO` - FO
* `FR` - FR
* `GA` - GA
* `GB` - GB
* `GD` - GD
* `GE` - GE
* `GF` - GF
* `GG` - GG
* `GH` - GH
* `GI` - GI
* `GL` - GL
* `GM` - GM
* `GN` - GN
* `GP` - GP
* `GQ` - GQ
* `GR` - GR
* `GT` - GT
* `GU` - GU
* `GW` - GW
* `GY` - GY
* `HK` - HK
* `HN` - HN
* `HR` - HR
* `HT` - HT
* `HU` - HU
* `IC` - IC
* `ID` - ID
* `IE` - IE
* `IL` - IL
* `IN` - IN
* `IQ` - IQ
* `IR` - IR
* `IS` - IS
* `IT` - IT
* `JE` - JE
* `JM` - JM
* `JO` - JO
* `JP` - JP
* `KE` - KE
* `KG` - KG
* `KH` - KH
* `KI` - KI
* `KM` - KM
* `KN` - KN
* `KP` - KP
* `KR` - KR
* `KV` - KV
* `KW` - KW
* `KY` - KY
* `KZ` - KZ
* `LA` - LA
* `LB` - LB
* `LC` - LC
* `LI` - LI
* `LK` - LK
* `LR` - LR
* `LS` - LS
* `LT` - LT
* `LU` - LU
* `LV` - LV
* `LY` - LY
* `MA` - MA
* `MC` - MC
* `MD` - MD
* `ME` - ME
* `MG` - MG
* `MH` - MH
* `MK` - MK
* `ML` - ML
* `MM` - MM
* `MN` - MN
* `MO` - MO
* `MP` - MP
* `MQ` - MQ
* `MR` - MR
* `MS` - MS
* `MT` - MT
* `MU` - MU
* `MV` - MV
* `MW` - MW
* `MX` - MX
* `MY` - MY
* `MZ` - MZ
* `NA` - NA
* `NC` - NC
* `NE` - NE
* `NG` - NG
* `NI` - NI
* `NL` - NL
* `NO` - NO
* `NP` - NP
* `NR` - NR
* `NU` - NU
* `NZ` - NZ
* `OM` - OM
* `PA` - PA
* `PE` - PE
* `PF` - PF
* `PG` - PG
* `PH` - PH
* `PK` - PK
* `PL` - PL
* `PR` - PR
* `PT` - PT
* `PW` - PW
* `PY` - PY
* `QA` - QA
* `RE` - RE
* `RO` - RO
* `RS` - RS
* `RU` - RU
* `RW` - RW
* `SA` - SA
* `SB` - SB
* `SC` - SC
* `SD` - SD
* `SE` - SE
* `SG` - SG
* `SH` - SH
* `SI` - SI
* `SK` - SK
* `SL` - SL
* `SM` - SM
* `SN` - SN
* `SO` - SO
* `SR` - SR
* `SS` - SS
* `ST` - ST
* `SV` - SV
* `SY` - SY
* `SZ` - SZ
* `TC` - TC
* `TD` - TD
* `TG` - TG
* `TH` - TH
* `TJ` - TJ
* `TL` - TL
* `TN` - TN
* `TO` - TO
* `TR` - TR
* `TT` - TT
* `TV` - TV
* `TW` - TW
* `TZ` - TZ
* `UA` - UA
* `UG` - UG
* `US` - US
* `UY` - UY
* `UZ` - UZ
* `VA` - VA
* `VC` - VC
* `VE` - VE
* `VG` - VG
* `VI` - VI
* `VN` - VN
* `VU` - VU
* `WS` - WS
* `XB` - XB
* `XC` - XC
* `XE` - XE
* `XM` - XM
* `XN` - XN
* `XS` - XS
* `XY` - XY
* `YE` - YE
* `YT` - YT
* `ZA` - ZA
* `ZM` - ZM
* `ZW` - ZW
parent_id:
type: string
nullable: true
description: The id of the related order line item.
metadata:
type: object
additionalProperties: {}
nullable: true
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 "
required:
- weight
- weight_unit
Customs:
type: object
properties:
id:
type: string
description: A unique identifier
commodities:
type: array
items:
$ref: '#/components/schemas/Commodity'
description: The parcel content items
duty:
allOf:
- $ref: '#/components/schemas/Duty'
nullable: true
description: "The payment details.
\n **Note that this is required\
\ for a Dutiable parcel shipped internationally.**\n "
duty_billing_address:
allOf:
- $ref: '#/components/schemas/Address'
nullable: true
description: The duty payor address.
content_type:
enum:
- documents
- gift
- sample
- merchandise
- return_merchandise
- other
- ''
- null
type: string
description: |-
* `documents` - documents
* `gift` - gift
* `sample` - sample
* `merchandise` - merchandise
* `return_merchandise` - return_merchandise
* `other` - other
nullable: true
content_description:
type: string
nullable: true
incoterm:
enum:
- CFR
- CIF
- CIP
- CPT
- DAF
- DDP
- DDU
- DEQ
- DES
- EXW
- FAS
- FCA
- FOB
- null
type: string
nullable: true
description: |-
The customs 'term of trade' also known as 'incoterm'
* `CFR` - CFR
* `CIF` - CIF
* `CIP` - CIP
* `CPT` - CPT
* `DAF` - DAF
* `DDP` - DDP
* `DDU` - DDU
* `DEQ` - DEQ
* `DES` - DES
* `EXW` - EXW
* `FAS` - FAS
* `FCA` - FCA
* `FOB` - FOB
invoice:
type: string
nullable: true
description: The invoice reference number
maxLength: 50
invoice_date:
type: string
nullable: true
description: The invoice date
commercial_invoice:
type: boolean
nullable: true
description: Indicates if the shipment is commercial
certify:
type: boolean
nullable: true
description: Indicate that signer certified confirmed all
signer:
type: string
nullable: true
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 \
\ "
object_type:
type: string
default: customs_info
description: Specifies the object type
CustomsData:
type: object
properties:
commodities:
type: array
items:
$ref: '#/components/schemas/CommodityData'
description: The parcel content items
duty:
allOf:
- $ref: '#/components/schemas/Duty'
nullable: true
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'
nullable: true
description: The duty payor address.
content_type:
enum:
- documents
- gift
- sample
- merchandise
- return_merchandise
- other
- ''
- null
type: string
description: |-
* `documents` - documents
* `gift` - gift
* `sample` - sample
* `merchandise` - merchandise
* `return_merchandise` - return_merchandise
* `other` - other
nullable: true
content_description:
type: string
nullable: true
incoterm:
enum:
- CFR
- CIF
- CIP
- CPT
- DAF
- DDP
- DDU
- DEQ
- DES
- EXW
- FAS
- FCA
- FOB
- null
type: string
nullable: true
description: |-
The customs 'term of trade' also known as 'incoterm'
* `CFR` - CFR
* `CIF` - CIF
* `CIP` - CIP
* `CPT` - CPT
* `DAF` - DAF
* `DDP` - DDP
* `DDU` - DDU
* `DEQ` - DEQ
* `DES` - DES
* `EXW` - EXW
* `FAS` - FAS
* `FCA` - FCA
* `FOB` - FOB
invoice:
type: string
nullable: true
description: The invoice reference number
maxLength: 50
invoice_date:
type: string
nullable: true
description: The invoice date
commercial_invoice:
type: boolean
nullable: true
description: Indicates if the shipment is commercial
certify:
type: boolean
nullable: true
description: Indicate that signer certified confirmed all
signer:
type: string
nullable: true
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 \
\ "
required:
- commodities
CustomsList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Customs'
required:
- results
DocumentDetails:
type: object
properties:
doc_id:
type: string
description: The uploaded document id.
file_name:
type: string
description: The uploaded document file name.
DocumentFileData:
type: object
properties:
doc_file:
type: string
description: A base64 file to upload
doc_name:
type: string
description: The file name
doc_format:
type: string
description: The file format
doc_type:
type: string
nullable: true
default: other
description: "\n Shipment document type\n\n values:
\n\
\ `certificate_of_origin` `commercial_invoice` `pro_forma_invoice`\
\ `packing_list` `other`\n\n For carrier specific packaging types,\
\ please consult the reference.\n "
maxLength: 50
required:
- doc_file
- doc_format
- doc_name
DocumentUploadData:
type: object
properties:
shipment_id:
type: string
description: The documents related shipment.
document_files:
type: array
items:
$ref: '#/components/schemas/DocumentFileData'
description: Shipping document files
reference:
type: string
nullable: true
description: Shipping document file reference
maxLength: 50
required:
- document_files
- shipment_id
DocumentUploadRecord:
type: object
properties:
id:
type: string
description: A unique identifier
carrier_name:
type: string
nullable: true
description: The shipment carrier
carrier_id:
type: string
nullable: true
description: The shipment carrier configured identifier
documents:
type: array
items:
$ref: '#/components/schemas/DocumentDetails'
default: []
description: the carrier shipping document ids
meta:
type: object
additionalProperties: {}
nullable: true
description: provider specific metadata
reference:
type: string
nullable: true
description: Shipping document file reference
maxLength: 50
messages:
type: array
items:
$ref: '#/components/schemas/Message'
default: []
description: The list of note or warning messages
DocumentUploadRecords:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/DocumentUploadRecord'
required:
- results
Documents:
type: object
properties:
label:
type: string
nullable: true
description: The shipment label in base64 string
invoice:
type: string
nullable: true
description: The shipment invoice in base64 string
Duty:
type: object
properties:
paid_by:
enum:
- sender
- recipient
- third_party
- ''
- null
type: string
nullable: true
description: |-
The duty payer
* `sender` - sender
* `recipient` - recipient
* `third_party` - third_party
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
- 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
nullable: true
description: |-
The declared value currency
* `EUR` - EUR
* `AED` - AED
* `USD` - USD
* `XCD` - XCD
* `AMD` - AMD
* `ANG` - ANG
* `AOA` - AOA
* `ARS` - ARS
* `AUD` - AUD
* `AWG` - AWG
* `AZN` - AZN
* `BAM` - BAM
* `BBD` - BBD
* `BDT` - BDT
* `XOF` - XOF
* `BGN` - BGN
* `BHD` - BHD
* `BIF` - BIF
* `BMD` - BMD
* `BND` - BND
* `BOB` - BOB
* `BRL` - BRL
* `BSD` - BSD
* `BTN` - BTN
* `BWP` - BWP
* `BYN` - BYN
* `BZD` - BZD
* `CAD` - CAD
* `CDF` - CDF
* `XAF` - XAF
* `CHF` - CHF
* `NZD` - NZD
* `CLP` - CLP
* `CNY` - CNY
* `COP` - COP
* `CRC` - CRC
* `CUC` - CUC
* `CVE` - CVE
* `CZK` - CZK
* `DJF` - DJF
* `DKK` - DKK
* `DOP` - DOP
* `DZD` - DZD
* `EGP` - EGP
* `ERN` - ERN
* `ETB` - ETB
* `FJD` - FJD
* `GBP` - GBP
* `GEL` - GEL
* `GHS` - GHS
* `GMD` - GMD
* `GNF` - GNF
* `GTQ` - GTQ
* `GYD` - GYD
* `HKD` - HKD
* `HNL` - HNL
* `HRK` - HRK
* `HTG` - HTG
* `HUF` - HUF
* `IDR` - IDR
* `ILS` - ILS
* `INR` - INR
* `IRR` - IRR
* `ISK` - ISK
* `JMD` - JMD
* `JOD` - JOD
* `JPY` - JPY
* `KES` - KES
* `KGS` - KGS
* `KHR` - KHR
* `KMF` - KMF
* `KPW` - KPW
* `KRW` - KRW
* `KWD` - KWD
* `KYD` - KYD
* `KZT` - KZT
* `LAK` - LAK
* `LKR` - LKR
* `LRD` - LRD
* `LSL` - LSL
* `LYD` - LYD
* `MAD` - MAD
* `MDL` - MDL
* `MGA` - MGA
* `MKD` - MKD
* `MMK` - MMK
* `MNT` - MNT
* `MOP` - MOP
* `MRO` - MRO
* `MUR` - MUR
* `MVR` - MVR
* `MWK` - MWK
* `MXN` - MXN
* `MYR` - MYR
* `MZN` - MZN
* `NAD` - NAD
* `XPF` - XPF
* `NGN` - NGN
* `NIO` - NIO
* `NOK` - NOK
* `NPR` - NPR
* `OMR` - OMR
* `PEN` - PEN
* `PGK` - PGK
* `PHP` - PHP
* `PKR` - PKR
* `PLN` - PLN
* `PYG` - PYG
* `QAR` - QAR
* `RSD` - RSD
* `RUB` - RUB
* `RWF` - RWF
* `SAR` - SAR
* `SBD` - SBD
* `SCR` - SCR
* `SDG` - SDG
* `SEK` - SEK
* `SGD` - SGD
* `SHP` - SHP
* `SLL` - SLL
* `SOS` - SOS
* `SRD` - SRD
* `SSP` - SSP
* `STD` - STD
* `SYP` - SYP
* `SZL` - SZL
* `THB` - THB
* `TJS` - TJS
* `TND` - TND
* `TOP` - TOP
* `TRY` - TRY
* `TTD` - TTD
* `TWD` - TWD
* `TZS` - TZS
* `UAH` - UAH
* `UYU` - UYU
* `UZS` - UZS
* `VEF` - VEF
* `VND` - VND
* `VUV` - VUV
* `WST` - WST
* `YER` - YER
* `ZAR` - ZAR
declared_value:
type: number
format: double
nullable: true
description: The package declared value
account_number:
type: string
nullable: true
description: The duty payment account number
ErrorMessages:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Message'
description: The list of error messages
ErrorResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/APIError'
description: The list of API errors
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
type: string
description: |-
The commodity's weight unit
* `KG` - KG
* `LB` - LB
title:
type: string
nullable: true
description: A description of the commodity
maxLength: 35
description:
type: string
nullable: true
description: A description of the commodity
maxLength: 100
quantity:
type: integer
default: 1
description: The commodity's quantity (number or item)
sku:
type: string
nullable: true
description: The commodity's sku number
maxLength: 35
hs_code:
type: string
nullable: true
description: The commodity's hs_code number
maxLength: 35
value_amount:
type: number
format: double
nullable: true
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
- 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
nullable: true
description: |-
The currency of the commodity value amount
* `EUR` - EUR
* `AED` - AED
* `USD` - USD
* `XCD` - XCD
* `AMD` - AMD
* `ANG` - ANG
* `AOA` - AOA
* `ARS` - ARS
* `AUD` - AUD
* `AWG` - AWG
* `AZN` - AZN
* `BAM` - BAM
* `BBD` - BBD
* `BDT` - BDT
* `XOF` - XOF
* `BGN` - BGN
* `BHD` - BHD
* `BIF` - BIF
* `BMD` - BMD
* `BND` - BND
* `BOB` - BOB
* `BRL` - BRL
* `BSD` - BSD
* `BTN` - BTN
* `BWP` - BWP
* `BYN` - BYN
* `BZD` - BZD
* `CAD` - CAD
* `CDF` - CDF
* `XAF` - XAF
* `CHF` - CHF
* `NZD` - NZD
* `CLP` - CLP
* `CNY` - CNY
* `COP` - COP
* `CRC` - CRC
* `CUC` - CUC
* `CVE` - CVE
* `CZK` - CZK
* `DJF` - DJF
* `DKK` - DKK
* `DOP` - DOP
* `DZD` - DZD
* `EGP` - EGP
* `ERN` - ERN
* `ETB` - ETB
* `FJD` - FJD
* `GBP` - GBP
* `GEL` - GEL
* `GHS` - GHS
* `GMD` - GMD
* `GNF` - GNF
* `GTQ` - GTQ
* `GYD` - GYD
* `HKD` - HKD
* `HNL` - HNL
* `HRK` - HRK
* `HTG` - HTG
* `HUF` - HUF
* `IDR` - IDR
* `ILS` - ILS
* `INR` - INR
* `IRR` - IRR
* `ISK` - ISK
* `JMD` - JMD
* `JOD` - JOD
* `JPY` - JPY
* `KES` - KES
* `KGS` - KGS
* `KHR` - KHR
* `KMF` - KMF
* `KPW` - KPW
* `KRW` - KRW
* `KWD` - KWD
* `KYD` - KYD
* `KZT` - KZT
* `LAK` - LAK
* `LKR` - LKR
* `LRD` - LRD
* `LSL` - LSL
* `LYD` - LYD
* `MAD` - MAD
* `MDL` - MDL
* `MGA` - MGA
* `MKD` - MKD
* `MMK` - MMK
* `MNT` - MNT
* `MOP` - MOP
* `MRO` - MRO
* `MUR` - MUR
* `MVR` - MVR
* `MWK` - MWK
* `MXN` - MXN
* `MYR` - MYR
* `MZN` - MZN
* `NAD` - NAD
* `XPF` - XPF
* `NGN` - NGN
* `NIO` - NIO
* `NOK` - NOK
* `NPR` - NPR
* `OMR` - OMR
* `PEN` - PEN
* `PGK` - PGK
* `PHP` - PHP
* `PKR` - PKR
* `PLN` - PLN
* `PYG` - PYG
* `QAR` - QAR
* `RSD` - RSD
* `RUB` - RUB
* `RWF` - RWF
* `SAR` - SAR
* `SBD` - SBD
* `SCR` - SCR
* `SDG` - SDG
* `SEK` - SEK
* `SGD` - SGD
* `SHP` - SHP
* `SLL` - SLL
* `SOS` - SOS
* `SRD` - SRD
* `SSP` - SSP
* `STD` - STD
* `SYP` - SYP
* `SZL` - SZL
* `THB` - THB
* `TJS` - TJS
* `TND` - TND
* `TOP` - TOP
* `TRY` - TRY
* `TTD` - TTD
* `TWD` - TWD
* `TZS` - TZS
* `UAH` - UAH
* `UYU` - UYU
* `UZS` - UZS
* `VEF` - VEF
* `VND` - VND
* `VUV` - VUV
* `WST` - WST
* `YER` - YER
* `ZAR` - ZAR
origin_country:
enum:
- 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
- null
type: string
nullable: true
description: |-
The origin or manufacture country
* `AD` - AD
* `AE` - AE
* `AF` - AF
* `AG` - AG
* `AI` - AI
* `AL` - AL
* `AM` - AM
* `AN` - AN
* `AO` - AO
* `AR` - AR
* `AS` - AS
* `AT` - AT
* `AU` - AU
* `AW` - AW
* `AZ` - AZ
* `BA` - BA
* `BB` - BB
* `BD` - BD
* `BE` - BE
* `BF` - BF
* `BG` - BG
* `BH` - BH
* `BI` - BI
* `BJ` - BJ
* `BM` - BM
* `BN` - BN
* `BO` - BO
* `BR` - BR
* `BS` - BS
* `BT` - BT
* `BW` - BW
* `BY` - BY
* `BZ` - BZ
* `CA` - CA
* `CD` - CD
* `CF` - CF
* `CG` - CG
* `CH` - CH
* `CI` - CI
* `CK` - CK
* `CL` - CL
* `CM` - CM
* `CN` - CN
* `CO` - CO
* `CR` - CR
* `CU` - CU
* `CV` - CV
* `CY` - CY
* `CZ` - CZ
* `DE` - DE
* `DJ` - DJ
* `DK` - DK
* `DM` - DM
* `DO` - DO
* `DZ` - DZ
* `EC` - EC
* `EE` - EE
* `EG` - EG
* `ER` - ER
* `ES` - ES
* `ET` - ET
* `FI` - FI
* `FJ` - FJ
* `FK` - FK
* `FM` - FM
* `FO` - FO
* `FR` - FR
* `GA` - GA
* `GB` - GB
* `GD` - GD
* `GE` - GE
* `GF` - GF
* `GG` - GG
* `GH` - GH
* `GI` - GI
* `GL` - GL
* `GM` - GM
* `GN` - GN
* `GP` - GP
* `GQ` - GQ
* `GR` - GR
* `GT` - GT
* `GU` - GU
* `GW` - GW
* `GY` - GY
* `HK` - HK
* `HN` - HN
* `HR` - HR
* `HT` - HT
* `HU` - HU
* `IC` - IC
* `ID` - ID
* `IE` - IE
* `IL` - IL
* `IN` - IN
* `IQ` - IQ
* `IR` - IR
* `IS` - IS
* `IT` - IT
* `JE` - JE
* `JM` - JM
* `JO` - JO
* `JP` - JP
* `KE` - KE
* `KG` - KG
* `KH` - KH
* `KI` - KI
* `KM` - KM
* `KN` - KN
* `KP` - KP
* `KR` - KR
* `KV` - KV
* `KW` - KW
* `KY` - KY
* `KZ` - KZ
* `LA` - LA
* `LB` - LB
* `LC` - LC
* `LI` - LI
* `LK` - LK
* `LR` - LR
* `LS` - LS
* `LT` - LT
* `LU` - LU
* `LV` - LV
* `LY` - LY
* `MA` - MA
* `MC` - MC
* `MD` - MD
* `ME` - ME
* `MG` - MG
* `MH` - MH
* `MK` - MK
* `ML` - ML
* `MM` - MM
* `MN` - MN
* `MO` - MO
* `MP` - MP
* `MQ` - MQ
* `MR` - MR
* `MS` - MS
* `MT` - MT
* `MU` - MU
* `MV` - MV
* `MW` - MW
* `MX` - MX
* `MY` - MY
* `MZ` - MZ
* `NA` - NA
* `NC` - NC
* `NE` - NE
* `NG` - NG
* `NI` - NI
* `NL` - NL
* `NO` - NO
* `NP` - NP
* `NR` - NR
* `NU` - NU
* `NZ` - NZ
* `OM` - OM
* `PA` - PA
* `PE` - PE
* `PF` - PF
* `PG` - PG
* `PH` - PH
* `PK` - PK
* `PL` - PL
* `PR` - PR
* `PT` - PT
* `PW` - PW
* `PY` - PY
* `QA` - QA
* `RE` - RE
* `RO` - RO
* `RS` - RS
* `RU` - RU
* `RW` - RW
* `SA` - SA
* `SB` - SB
* `SC` - SC
* `SD` - SD
* `SE` - SE
* `SG` - SG
* `SH` - SH
* `SI` - SI
* `SK` - SK
* `SL` - SL
* `SM` - SM
* `SN` - SN
* `SO` - SO
* `SR` - SR
* `SS` - SS
* `ST` - ST
* `SV` - SV
* `SY` - SY
* `SZ` - SZ
* `TC` - TC
* `TD` - TD
* `TG` - TG
* `TH` - TH
* `TJ` - TJ
* `TL` - TL
* `TN` - TN
* `TO` - TO
* `TR` - TR
* `TT` - TT
* `TV` - TV
* `TW` - TW
* `TZ` - TZ
* `UA` - UA
* `UG` - UG
* `US` - US
* `UY` - UY
* `UZ` - UZ
* `VA` - VA
* `VC` - VC
* `VE` - VE
* `VG` - VG
* `VI` - VI
* `VN` - VN
* `VU` - VU
* `WS` - WS
* `XB` - XB
* `XC` - XC
* `XE` - XE
* `XM` - XM
* `XN` - XN
* `XS` - XS
* `XY` - XY
* `YE` - YE
* `YT` - YT
* `ZA` - ZA
* `ZM` - ZM
* `ZW` - ZW
parent_id:
type: string
nullable: true
description: The id of the related order line item.
metadata:
type: object
additionalProperties: {}
nullable: true
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 "
object_type:
type: string
default: commodity
description: Specifies the object type
unfulfilled_quantity:
type: integer
default: 0
required:
- weight
- weight_unit
Message:
type: object
properties:
message:
type: string
description: The error or warning message
code:
type: string
description: The message code
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)
Operation:
type: object
properties:
operation:
type: string
description: Operation performed
success:
type: boolean
description: Specify whether the operation was successful
required:
- operation
- success
OperationConfirmation:
type: object
properties:
operation:
type: string
description: Operation performed
success:
type: boolean
description: Specify whether the operation was successful
carrier_name:
type: string
description: The operation carrier
carrier_id:
type: string
description: The targeted carrier's name (unique identifier)
required:
- carrier_id
- carrier_name
- operation
- success
OperationResponse:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Message'
description: The list of note or warning messages
confirmation:
allOf:
- $ref: '#/components/schemas/OperationConfirmation'
description: The operation details
Order:
type: object
properties:
id:
type: string
description: A unique identifier
object_type:
type: string
default: order
description: Specifies the object type
order_id:
type: string
description: The source' order id.
order_date:
type: string
nullable: true
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
default: unfulfilled
description: |-
The order status.
* `unfulfilled` - unfulfilled
* `cancelled` - cancelled
* `fulfilled` - fulfilled
* `delivered` - delivered
* `partial` - partial
shipping_to:
allOf:
- $ref: '#/components/schemas/Address'
description: The customer address for the order.
shipping_from:
allOf:
- $ref: '#/components/schemas/Address'
nullable: true
description: The origin or warehouse address of the order items.
billing_address:
allOf:
- $ref: '#/components/schemas/AddressData'
nullable: true
description: The customer' or shipping billing address.
line_items:
type: array
items:
$ref: '#/components/schemas/LineItem'
description: The order line items.
options:
type: object
additionalProperties: {}
nullable: true
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 "
meta:
type: object
additionalProperties: {}
nullable: true
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
OrderData:
type: object
properties:
order_id:
type: string
description: The source' order id.
order_date:
type: string
nullable: true
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'
nullable: true
description: The origin or warehouse address of the order items.
billing_address:
allOf:
- $ref: '#/components/schemas/AddressData'
nullable: true
description: The customer' or shipping billing address.
line_items:
type: array
items:
$ref: '#/components/schemas/CommodityData'
description: The order line items.
options:
type: object
additionalProperties: {}
nullable: true
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 "
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the order.
required:
- line_items
- order_id
- shipping_to
OrderList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Order'
required:
- results
OrderUpdateData:
type: object
properties:
options:
type: object
additionalProperties: {}
nullable: true
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 "
metadata:
type: object
additionalProperties: {}
description: User metadata for the shipment
Parcel:
type: object
properties:
id:
type: string
description: A unique identifier
weight:
type: number
format: double
description: The parcel's weight
width:
type: number
format: double
nullable: true
description: The parcel's width
height:
type: number
format: double
nullable: true
description: The parcel's height
length:
type: number
format: double
nullable: true
description: The parcel's length
packaging_type:
type: string
nullable: true
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: 50
package_preset:
type: string
nullable: true
description: "The parcel's package preset.
\n For carrier specific\
\ package presets, please consult the reference.\n "
maxLength: 50
description:
type: string
nullable: true
description: The parcel's description
maxLength: 250
content:
type: string
nullable: true
description: The parcel's content description
maxLength: 100
is_document:
type: boolean
nullable: true
default: false
description: Indicates if the parcel is composed of documents only
weight_unit:
enum:
- KG
- LB
type: string
description: |-
The parcel's weight unit
* `KG` - KG
* `LB` - LB
dimension_unit:
enum:
- CM
- IN
- null
type: string
nullable: true
description: |-
The parcel's dimension unit
* `CM` - CM
* `IN` - IN
items:
type: array
items:
$ref: '#/components/schemas/Commodity'
description: The parcel items.
reference_number:
type: string
nullable: true
description: "The parcel reference number.
\n (can be used as\
\ tracking number for custom carriers)\n "
maxLength: 100
freight_class:
type: string
nullable: true
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 "
object_type:
type: string
default: parcel
description: Specifies the object type
required:
- weight
- weight_unit
ParcelData:
type: object
properties:
weight:
type: number
format: double
description: The parcel's weight
width:
type: number
format: double
nullable: true
description: The parcel's width
height:
type: number
format: double
nullable: true
description: The parcel's height
length:
type: number
format: double
nullable: true
description: The parcel's length
packaging_type:
type: string
nullable: true
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: 50
package_preset:
type: string
nullable: true
description: "The parcel's package preset.
\n For carrier specific\
\ package presets, please consult the reference.\n "
maxLength: 50
description:
type: string
nullable: true
description: The parcel's description
maxLength: 250
content:
type: string
nullable: true
description: The parcel's content description
maxLength: 100
is_document:
type: boolean
nullable: true
default: false
description: Indicates if the parcel is composed of documents only
weight_unit:
enum:
- KG
- LB
type: string
description: |-
The parcel's weight unit
* `KG` - KG
* `LB` - LB
dimension_unit:
enum:
- CM
- IN
- null
type: string
nullable: true
description: |-
The parcel's dimension unit
* `CM` - CM
* `IN` - IN
items:
type: array
items:
$ref: '#/components/schemas/CommodityData'
description: The parcel items.
reference_number:
type: string
nullable: true
description: "The parcel reference number.
\n (can be used as\
\ tracking number for custom carriers)\n "
maxLength: 100
freight_class:
type: string
nullable: true
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 "
required:
- weight
- weight_unit
ParcelList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Parcel'
required:
- results
PatchedAddressData:
type: object
properties:
postal_code:
type: string
nullable: true
description: "The address postal code\n **(required for shipment\
\ purchase)**\n "
maxLength: 10
city:
type: string
nullable: true
description: "The address city.\n **(required for shipment purchase)**\n\
\ "
maxLength: 30
federal_tax_id:
type: string
nullable: true
description: The party frederal tax id
maxLength: 20
state_tax_id:
type: string
nullable: true
description: The party state id
maxLength: 20
person_name:
type: string
nullable: true
description: "Attention to\n **(required for shipment purchase)**\n\
\ "
maxLength: 30
company_name:
type: string
nullable: true
description: The company name if the party is a company
maxLength: 30
country_code:
enum:
- 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
type: string
description: |-
The address country code
* `AD` - AD
* `AE` - AE
* `AF` - AF
* `AG` - AG
* `AI` - AI
* `AL` - AL
* `AM` - AM
* `AN` - AN
* `AO` - AO
* `AR` - AR
* `AS` - AS
* `AT` - AT
* `AU` - AU
* `AW` - AW
* `AZ` - AZ
* `BA` - BA
* `BB` - BB
* `BD` - BD
* `BE` - BE
* `BF` - BF
* `BG` - BG
* `BH` - BH
* `BI` - BI
* `BJ` - BJ
* `BM` - BM
* `BN` - BN
* `BO` - BO
* `BR` - BR
* `BS` - BS
* `BT` - BT
* `BW` - BW
* `BY` - BY
* `BZ` - BZ
* `CA` - CA
* `CD` - CD
* `CF` - CF
* `CG` - CG
* `CH` - CH
* `CI` - CI
* `CK` - CK
* `CL` - CL
* `CM` - CM
* `CN` - CN
* `CO` - CO
* `CR` - CR
* `CU` - CU
* `CV` - CV
* `CY` - CY
* `CZ` - CZ
* `DE` - DE
* `DJ` - DJ
* `DK` - DK
* `DM` - DM
* `DO` - DO
* `DZ` - DZ
* `EC` - EC
* `EE` - EE
* `EG` - EG
* `ER` - ER
* `ES` - ES
* `ET` - ET
* `FI` - FI
* `FJ` - FJ
* `FK` - FK
* `FM` - FM
* `FO` - FO
* `FR` - FR
* `GA` - GA
* `GB` - GB
* `GD` - GD
* `GE` - GE
* `GF` - GF
* `GG` - GG
* `GH` - GH
* `GI` - GI
* `GL` - GL
* `GM` - GM
* `GN` - GN
* `GP` - GP
* `GQ` - GQ
* `GR` - GR
* `GT` - GT
* `GU` - GU
* `GW` - GW
* `GY` - GY
* `HK` - HK
* `HN` - HN
* `HR` - HR
* `HT` - HT
* `HU` - HU
* `IC` - IC
* `ID` - ID
* `IE` - IE
* `IL` - IL
* `IN` - IN
* `IQ` - IQ
* `IR` - IR
* `IS` - IS
* `IT` - IT
* `JE` - JE
* `JM` - JM
* `JO` - JO
* `JP` - JP
* `KE` - KE
* `KG` - KG
* `KH` - KH
* `KI` - KI
* `KM` - KM
* `KN` - KN
* `KP` - KP
* `KR` - KR
* `KV` - KV
* `KW` - KW
* `KY` - KY
* `KZ` - KZ
* `LA` - LA
* `LB` - LB
* `LC` - LC
* `LI` - LI
* `LK` - LK
* `LR` - LR
* `LS` - LS
* `LT` - LT
* `LU` - LU
* `LV` - LV
* `LY` - LY
* `MA` - MA
* `MC` - MC
* `MD` - MD
* `ME` - ME
* `MG` - MG
* `MH` - MH
* `MK` - MK
* `ML` - ML
* `MM` - MM
* `MN` - MN
* `MO` - MO
* `MP` - MP
* `MQ` - MQ
* `MR` - MR
* `MS` - MS
* `MT` - MT
* `MU` - MU
* `MV` - MV
* `MW` - MW
* `MX` - MX
* `MY` - MY
* `MZ` - MZ
* `NA` - NA
* `NC` - NC
* `NE` - NE
* `NG` - NG
* `NI` - NI
* `NL` - NL
* `NO` - NO
* `NP` - NP
* `NR` - NR
* `NU` - NU
* `NZ` - NZ
* `OM` - OM
* `PA` - PA
* `PE` - PE
* `PF` - PF
* `PG` - PG
* `PH` - PH
* `PK` - PK
* `PL` - PL
* `PR` - PR
* `PT` - PT
* `PW` - PW
* `PY` - PY
* `QA` - QA
* `RE` - RE
* `RO` - RO
* `RS` - RS
* `RU` - RU
* `RW` - RW
* `SA` - SA
* `SB` - SB
* `SC` - SC
* `SD` - SD
* `SE` - SE
* `SG` - SG
* `SH` - SH
* `SI` - SI
* `SK` - SK
* `SL` - SL
* `SM` - SM
* `SN` - SN
* `SO` - SO
* `SR` - SR
* `SS` - SS
* `ST` - ST
* `SV` - SV
* `SY` - SY
* `SZ` - SZ
* `TC` - TC
* `TD` - TD
* `TG` - TG
* `TH` - TH
* `TJ` - TJ
* `TL` - TL
* `TN` - TN
* `TO` - TO
* `TR` - TR
* `TT` - TT
* `TV` - TV
* `TW` - TW
* `TZ` - TZ
* `UA` - UA
* `UG` - UG
* `US` - US
* `UY` - UY
* `UZ` - UZ
* `VA` - VA
* `VC` - VC
* `VE` - VE
* `VG` - VG
* `VI` - VI
* `VN` - VN
* `VU` - VU
* `WS` - WS
* `XB` - XB
* `XC` - XC
* `XE` - XE
* `XM` - XM
* `XN` - XN
* `XS` - XS
* `XY` - XY
* `YE` - YE
* `YT` - YT
* `ZA` - ZA
* `ZM` - ZM
* `ZW` - ZW
email:
type: string
nullable: true
description: The party email
phone_number:
type: string
nullable: true
description: The party phone number.
maxLength: 20
state_code:
type: string
nullable: true
description: The address state code
maxLength: 20
suburb:
type: string
nullable: true
description: The address suburb if known
maxLength: 20
residential:
type: boolean
nullable: true
default: false
description: Indicate if the address is residential or commercial (enterprise)
street_number:
type: string
nullable: true
description: The address street number
maxLength: 20
address_line1:
type: string
nullable: true
description: "The address line with street number
\n **(required\
\ for shipment purchase)**\n "
maxLength: 50
address_line2:
type: string
nullable: true
description: The address line with suite number
maxLength: 50
validate_location:
type: boolean
nullable: true
default: false
description: Indicate if the address should be validated
PatchedCustomsData:
type: object
properties:
commodities:
type: array
items:
$ref: '#/components/schemas/CommodityData'
description: The parcel content items
duty:
allOf:
- $ref: '#/components/schemas/Duty'
nullable: true
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'
nullable: true
description: The duty payor address.
content_type:
enum:
- documents
- gift
- sample
- merchandise
- return_merchandise
- other
- ''
- null
type: string
description: |-
* `documents` - documents
* `gift` - gift
* `sample` - sample
* `merchandise` - merchandise
* `return_merchandise` - return_merchandise
* `other` - other
nullable: true
content_description:
type: string
nullable: true
incoterm:
enum:
- CFR
- CIF
- CIP
- CPT
- DAF
- DDP
- DDU
- DEQ
- DES
- EXW
- FAS
- FCA
- FOB
- null
type: string
nullable: true
description: |-
The customs 'term of trade' also known as 'incoterm'
* `CFR` - CFR
* `CIF` - CIF
* `CIP` - CIP
* `CPT` - CPT
* `DAF` - DAF
* `DDP` - DDP
* `DDU` - DDU
* `DEQ` - DEQ
* `DES` - DES
* `EXW` - EXW
* `FAS` - FAS
* `FCA` - FCA
* `FOB` - FOB
invoice:
type: string
nullable: true
description: The invoice reference number
maxLength: 50
invoice_date:
type: string
nullable: true
description: The invoice date
commercial_invoice:
type: boolean
nullable: true
description: Indicates if the shipment is commercial
certify:
type: boolean
nullable: true
description: Indicate that signer certified confirmed all
signer:
type: string
nullable: true
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 \
\ "
PatchedParcelData:
type: object
properties:
weight:
type: number
format: double
description: The parcel's weight
width:
type: number
format: double
nullable: true
description: The parcel's width
height:
type: number
format: double
nullable: true
description: The parcel's height
length:
type: number
format: double
nullable: true
description: The parcel's length
packaging_type:
type: string
nullable: true
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: 50
package_preset:
type: string
nullable: true
description: "The parcel's package preset.
\n For carrier specific\
\ package presets, please consult the reference.\n "
maxLength: 50
description:
type: string
nullable: true
description: The parcel's description
maxLength: 250
content:
type: string
nullable: true
description: The parcel's content description
maxLength: 100
is_document:
type: boolean
nullable: true
default: false
description: Indicates if the parcel is composed of documents only
weight_unit:
enum:
- KG
- LB
type: string
description: |-
The parcel's weight unit
* `KG` - KG
* `LB` - LB
dimension_unit:
enum:
- CM
- IN
- null
type: string
nullable: true
description: |-
The parcel's dimension unit
* `CM` - CM
* `IN` - IN
items:
type: array
items:
$ref: '#/components/schemas/CommodityData'
description: The parcel items.
reference_number:
type: string
nullable: true
description: "The parcel reference number.
\n (can be used as\
\ tracking number for custom carriers)\n "
maxLength: 100
freight_class:
type: string
nullable: true
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 "
PatchedWebhookData:
type: object
properties:
url:
type: string
format: uri
description: The URL of the webhook endpoint.
description:
type: string
nullable: true
description: An optional description of what the webhook is used for.
enabled_events:
type: array
items:
enum:
- all
- shipment_purchased
- shipment_cancelled
- shipment_fulfilled
- tracker_created
- tracker_updated
- order_created
- order_updated
- order_fulfilled
- order_cancelled
- order_delivered
- batch_queued
- batch_failed
- batch_running
- batch_completed
type: string
description: |-
* `all` - all
* `shipment_purchased` - shipment_purchased
* `shipment_cancelled` - shipment_cancelled
* `shipment_fulfilled` - shipment_fulfilled
* `tracker_created` - tracker_created
* `tracker_updated` - tracker_updated
* `order_created` - order_created
* `order_updated` - order_updated
* `order_fulfilled` - order_fulfilled
* `order_cancelled` - order_cancelled
* `order_delivered` - order_delivered
* `batch_queued` - batch_queued
* `batch_failed` - batch_failed
* `batch_running` - batch_running
* `batch_completed` - batch_completed
description: The list of events to enable for this endpoint.
disabled:
type: boolean
nullable: true
description: Indicates that the webhook is disabled
Payment:
type: object
properties:
paid_by:
enum:
- sender
- recipient
- third_party
type: string
default: sender
description: |-
The payor type
* `sender` - sender
* `recipient` - recipient
* `third_party` - third_party
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
- 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
nullable: true
description: |-
The payment amount currency
* `EUR` - EUR
* `AED` - AED
* `USD` - USD
* `XCD` - XCD
* `AMD` - AMD
* `ANG` - ANG
* `AOA` - AOA
* `ARS` - ARS
* `AUD` - AUD
* `AWG` - AWG
* `AZN` - AZN
* `BAM` - BAM
* `BBD` - BBD
* `BDT` - BDT
* `XOF` - XOF
* `BGN` - BGN
* `BHD` - BHD
* `BIF` - BIF
* `BMD` - BMD
* `BND` - BND
* `BOB` - BOB
* `BRL` - BRL
* `BSD` - BSD
* `BTN` - BTN
* `BWP` - BWP
* `BYN` - BYN
* `BZD` - BZD
* `CAD` - CAD
* `CDF` - CDF
* `XAF` - XAF
* `CHF` - CHF
* `NZD` - NZD
* `CLP` - CLP
* `CNY` - CNY
* `COP` - COP
* `CRC` - CRC
* `CUC` - CUC
* `CVE` - CVE
* `CZK` - CZK
* `DJF` - DJF
* `DKK` - DKK
* `DOP` - DOP
* `DZD` - DZD
* `EGP` - EGP
* `ERN` - ERN
* `ETB` - ETB
* `FJD` - FJD
* `GBP` - GBP
* `GEL` - GEL
* `GHS` - GHS
* `GMD` - GMD
* `GNF` - GNF
* `GTQ` - GTQ
* `GYD` - GYD
* `HKD` - HKD
* `HNL` - HNL
* `HRK` - HRK
* `HTG` - HTG
* `HUF` - HUF
* `IDR` - IDR
* `ILS` - ILS
* `INR` - INR
* `IRR` - IRR
* `ISK` - ISK
* `JMD` - JMD
* `JOD` - JOD
* `JPY` - JPY
* `KES` - KES
* `KGS` - KGS
* `KHR` - KHR
* `KMF` - KMF
* `KPW` - KPW
* `KRW` - KRW
* `KWD` - KWD
* `KYD` - KYD
* `KZT` - KZT
* `LAK` - LAK
* `LKR` - LKR
* `LRD` - LRD
* `LSL` - LSL
* `LYD` - LYD
* `MAD` - MAD
* `MDL` - MDL
* `MGA` - MGA
* `MKD` - MKD
* `MMK` - MMK
* `MNT` - MNT
* `MOP` - MOP
* `MRO` - MRO
* `MUR` - MUR
* `MVR` - MVR
* `MWK` - MWK
* `MXN` - MXN
* `MYR` - MYR
* `MZN` - MZN
* `NAD` - NAD
* `XPF` - XPF
* `NGN` - NGN
* `NIO` - NIO
* `NOK` - NOK
* `NPR` - NPR
* `OMR` - OMR
* `PEN` - PEN
* `PGK` - PGK
* `PHP` - PHP
* `PKR` - PKR
* `PLN` - PLN
* `PYG` - PYG
* `QAR` - QAR
* `RSD` - RSD
* `RUB` - RUB
* `RWF` - RWF
* `SAR` - SAR
* `SBD` - SBD
* `SCR` - SCR
* `SDG` - SDG
* `SEK` - SEK
* `SGD` - SGD
* `SHP` - SHP
* `SLL` - SLL
* `SOS` - SOS
* `SRD` - SRD
* `SSP` - SSP
* `STD` - STD
* `SYP` - SYP
* `SZL` - SZL
* `THB` - THB
* `TJS` - TJS
* `TND` - TND
* `TOP` - TOP
* `TRY` - TRY
* `TTD` - TTD
* `TWD` - TWD
* `TZS` - TZS
* `UAH` - UAH
* `UYU` - UYU
* `UZS` - UZS
* `VEF` - VEF
* `VND` - VND
* `VUV` - VUV
* `WST` - WST
* `YER` - YER
* `ZAR` - ZAR
account_number:
type: string
nullable: true
description: The payor account number
Pickup:
type: object
properties:
id:
type: string
description: A unique pickup identifier
object_type:
type: string
default: pickup
description: Specifies the object type
carrier_name:
type: string
description: The pickup carrier
carrier_id:
type: string
description: The pickup carrier configured name
confirmation_number:
type: string
description: The pickup confirmation identifier
pickup_date:
type: string
nullable: true
description: The pickup date
pickup_charge:
allOf:
- $ref: '#/components/schemas/Charge'
nullable: true
description: The pickup cost details
ready_time:
type: string
nullable: true
description: The pickup expected ready time
closing_time:
type: string
nullable: true
description: The pickup expected closing or late time
address:
allOf:
- $ref: '#/components/schemas/Address'
description: The pickup address
parcels:
type: array
items:
$ref: '#/components/schemas/Parcel'
description: The shipment parcels to pickup.
instruction:
type: string
nullable: true
description: "The pickup instruction.
\n eg: Handle with care.\n\
\ "
maxLength: 50
package_location:
type: string
nullable: true
description: "The package(s) location.
\n eg: Behind the entrance\
\ door.\n "
maxLength: 50
options:
type: object
additionalProperties: {}
nullable: true
description: Advanced carrier specific pickup options
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the pickup
test_mode:
type: boolean
description: Specified whether it was created with a carrier in test mode
required:
- address
- carrier_id
- carrier_name
- confirmation_number
- parcels
- test_mode
PickupCancelData:
type: object
properties:
reason:
type: string
description: The reason of the pickup cancellation
PickupCancelRequest:
type: object
properties:
confirmation_number:
type: string
description: The pickup confirmation identifier
address:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The pickup address
pickup_date:
type: string
nullable: true
description: "The pickup date.
\n Date Format: `YYYY-MM-DD`\n\
\ "
reason:
type: string
description: The reason of the pickup cancellation
required:
- confirmation_number
PickupData:
type: object
properties:
pickup_date:
type: string
description: "The expected pickup date.
\n Date Format: `YYYY-MM-DD`\n\
\ "
address:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The pickup address
ready_time:
type: string
description: "The ready time for pickup.
\n Time Format: `HH:MM`\n\
\ "
closing_time:
type: string
description: "The closing or late time of the pickup.
\n Time\
\ Format: `HH:MM`\n "
instruction:
type: string
nullable: true
description: "The pickup instruction.
\n eg: Handle with care.\n\
\ "
maxLength: 50
package_location:
type: string
nullable: true
description: "The package(s) location.
\n eg: Behind the entrance\
\ door.\n "
maxLength: 50
options:
type: object
additionalProperties: {}
nullable: true
description: Advanced carrier specific pickup options
tracking_numbers:
type: array
items:
type: string
description: The list of shipments to be picked up
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the pickup
required:
- closing_time
- pickup_date
- ready_time
- tracking_numbers
PickupList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Pickup'
required:
- results
PickupRequest:
type: object
properties:
pickup_date:
type: string
description: "The expected pickup date.
\n Date Format: `YYYY-MM-DD`\n\
\ "
address:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The pickup address
parcels:
type: array
items:
$ref: '#/components/schemas/ParcelData'
description: The shipment parcels to pickup.
ready_time:
type: string
description: "The ready time for pickup.
\n Time Format: `HH:MM`\n\
\ "
closing_time:
type: string
description: "The closing or late time of the pickup.
\n Time\
\ Format: `HH:MM`\n "
instruction:
type: string
nullable: true
description: "The pickup instruction.
\n eg: Handle with care.\n\
\ "
maxLength: 50
package_location:
type: string
nullable: true
description: "The package(s) location.
\n eg: Behind the entrance\
\ door.\n "
maxLength: 50
options:
type: object
additionalProperties: {}
nullable: true
description: Advanced carrier specific pickup options
required:
- address
- closing_time
- parcels
- pickup_date
- ready_time
PickupResponse:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Message'
description: The list of note or warning messages
pickup:
allOf:
- $ref: '#/components/schemas/Pickup'
description: The scheduled pickup's summary
PickupUpdateData:
type: object
properties:
pickup_date:
type: string
description: "The expected pickup date.
\n Date Format: YYYY-MM-DD\n\
\ "
address:
allOf:
- $ref: '#/components/schemas/AddressData'
description: The pickup address
ready_time:
type: string
nullable: true
description: The ready time for pickup.
closing_time:
type: string
nullable: true
description: The closing or late time of the pickup
instruction:
type: string
nullable: true
description: "The pickup instruction.
\n eg: Handle with care.\n\
\ "
package_location:
type: string
nullable: true
description: "The package(s) location.
\n eg: Behind the entrance\
\ door.\n "
options:
type: object
additionalProperties: {}
nullable: true
description: Advanced carrier specific pickup options
tracking_numbers:
type: array
items:
type: string
description: The list of shipments to be picked up
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the pickup
confirmation_number:
type: string
description: pickup identification number
required:
- confirmation_number
PickupUpdateRequest:
type: object
properties:
pickup_date:
type: string
description: "The expected pickup date.
\n Date Format: `YYYY-MM-DD`\n\
\ "
address:
allOf:
- $ref: '#/components/schemas/Address'
description: The pickup address
parcels:
type: array
items:
$ref: '#/components/schemas/Parcel'
description: The shipment parcels to pickup.
confirmation_number:
type: string
description: pickup identification number
ready_time:
type: string
description: "The ready time for pickup.\n Time Format: `HH:MM`\n\
\ "
closing_time:
type: string
description: "The closing or late time of the pickup.
\n Time\
\ Format: `HH:MM`\n "
instruction:
type: string
nullable: true
description: "The pickup instruction.
\n eg: Handle with care.\n\
\ "
maxLength: 50
package_location:
type: string
nullable: true
description: "The package(s) location.
\n eg: Behind the entrance\
\ door.\n "
maxLength: 50
options:
type: object
additionalProperties: {}
nullable: true
description: Advanced carrier specific pickup options
required:
- address
- closing_time
- confirmation_number
- parcels
- pickup_date
- ready_time
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
nullable: true
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
nullable: true
description: The estimated delivery transit days
extra_charges:
type: array
items:
$ref: '#/components/schemas/Charge'
default: []
description: list of the rate's additional charges
meta:
type: object
additionalProperties: {}
nullable: true
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
RateRequest:
type: object
properties:
shipper:
allOf:
- $ref: '#/components/schemas/AddressData'
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/AddressData'
description: "The address of the party
\n Origin address (ship\
\ from) for the **shipper**
\n Destination address (ship to)\
\ for the **recipient**\n "
parcels:
type: array
items:
$ref: '#/components/schemas/ParcelData'
description: The shipment's parcels
services:
type: array
items:
type: string
nullable: true
description: "The requested carrier service 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 \"shipment_date\": \"2020-01-01\",\n \
\ \"dangerous_good\": true,\n \"declared_value\": 150.00,\n\
\ \"email_notification\": true,\n \"email_notification_to\"\
: \"shipper@mail.com\",\n \"signature_confirmation\": true,\n\
\ \"preferred_service\": \"fedex_express_saver\",\n \
\ }\n "
reference:
type: string
nullable: true
description: The shipment reference
carrier_ids:
type: array
items:
type: string
nullable: true
description: The list of configured carriers you wish to get rates from.
required:
- parcels
- recipient
- shipper
RateResponse:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Message'
description: The list of note or warning messages
rates:
type: array
items:
$ref: '#/components/schemas/Rate'
description: The list of returned rates
required:
- rates
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
format: uri
nullable: true
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 "
parcels:
type: array
items:
$ref: '#/components/schemas/Parcel'
description: The shipment's parcels
services:
type: array
items:
type: string
nullable: true
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 \"shipment_date\": \"2020-01-01\",\n \
\ \"dangerous_good\": true,\n \"declared_value\": 150.00,\n\
\ \"email_notification\": true,\n \"email_notification_to\"\
: \"shipper@mail.com\",\n \"signature_confirmation\": true,\n\
\ \"preferred_service\": \"fedex_express_saver\",\n \
\ }\n "
payment:
allOf:
- $ref: '#/components/schemas/Payment'
default:
paid_by: sender
currency: null
account_number: null
description: The payment details
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
nullable: true
description: The payor address.
customs:
allOf:
- $ref: '#/components/schemas/Customs'
nullable: true
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
nullable: true
description: The shipment reference
label_type:
enum:
- PDF
- ZPL
- PNG
- ''
- null
type: string
nullable: true
description: |-
The shipment label file type.
* `PDF` - PDF
* `ZPL` - ZPL
* `PNG` - PNG
carrier_ids:
type: array
items:
type: string
nullable: true
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
nullable: true
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
status:
enum:
- draft
- purchased
- cancelled
- shipped
- in_transit
- delivered
type: string
default: draft
description: |-
The current Shipment status
* `draft` - draft
* `purchased` - purchased
* `cancelled` - cancelled
* `shipped` - shipped
* `in_transit` - in_transit
* `delivered` - delivered
carrier_name:
type: string
nullable: true
description: The shipment carrier
carrier_id:
type: string
nullable: true
description: The shipment carrier configured identifier
tracking_number:
type: string
nullable: true
description: The shipment tracking number
shipment_identifier:
type: string
nullable: true
description: The shipment carrier system identifier
selected_rate:
allOf:
- $ref: '#/components/schemas/Rate'
nullable: true
description: The shipment selected rate
meta:
type: object
additionalProperties: {}
nullable: true
description: provider specific metadata
service:
type: string
nullable: true
description: The selected service
selected_rate_id:
type: string
nullable: true
description: The shipment selected rate.
test_mode:
type: boolean
description: Specified whether it was created with a carrier in test mode
label_url:
type: string
format: uri
nullable: true
description: The shipment label URL
invoice_url:
type: string
format: uri
nullable: true
description: The shipment invoice URL
required:
- created_at
- parcels
- recipient
- shipper
- test_mode
ShipmentCancelRequest:
type: object
properties:
shipment_identifier:
type: string
description: The shipment identifier returned during creation
service:
type: string
nullable: true
description: The selected shipment service
options:
type: object
additionalProperties: {}
default: {}
description: Advanced carrier specific cancellation options
required:
- shipment_identifier
ShipmentData:
type: object
properties:
shipper:
allOf:
- $ref: '#/components/schemas/AddressData'
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/AddressData'
description: "The address of the party.
\n Origin address (ship\
\ from) for the **shipper**
\n Destination address (ship to)\
\ for the **recipient**\n "
parcels:
type: array
items:
$ref: '#/components/schemas/ParcelData'
description: The shipment's parcels
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 \"shipment_date\": \"2020-01-01\",\n \
\ \"dangerous_good\": true,\n \"declared_value\": 150.00,\n\
\ \"email_notification\": true,\n \"email_notification_to\"\
: \"shipper@mail.com\",\n \"signature_confirmation\": true,\n\
\ \"preferred_service\": \"fedex_express_saver\",\n \
\ }\n "
payment:
allOf:
- $ref: '#/components/schemas/Payment'
default:
paid_by: sender
currency: null
account_number: null
description: The payment details
billing_address:
allOf:
- $ref: '#/components/schemas/AddressData'
nullable: true
description: The payor address.
customs:
allOf:
- $ref: '#/components/schemas/CustomsData'
nullable: true
description: "The customs details.
\n **Note that this is required\
\ for the shipment of an international Dutiable parcel.**\n "
reference:
type: string
nullable: true
description: The shipment reference
maxLength: 35
label_type:
enum:
- PDF
- ZPL
- PNG
type: string
default: PDF
description: |-
The shipment label file type.
* `PDF` - PDF
* `ZPL` - ZPL
* `PNG` - PNG
service:
type: string
description: '**Specify a service to Buy a label in one call without rating.**'
services:
type: array
items:
type: string
nullable: true
default: []
description: "The requested carrier service 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\n\
\ you could specify a service per carrier.**\n "
carrier_ids:
type: array
items:
type: string
nullable: true
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 "
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the shipment
required:
- parcels
- recipient
- shipper
ShipmentList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Shipment'
required:
- results
ShipmentPurchaseData:
type: object
properties:
selected_rate_id:
type: string
description: The shipment selected rate.
label_type:
enum:
- PDF
- ZPL
- PNG
type: string
default: PDF
description: |-
The shipment label file type.
* `PDF` - PDF
* `ZPL` - ZPL
* `PNG` - PNG
payment:
allOf:
- $ref: '#/components/schemas/Payment'
description: The payment details
reference:
type: string
nullable: true
description: The shipment reference
metadata:
type: object
additionalProperties: {}
description: User metadata for the shipment
required:
- selected_rate_id
ShipmentRateData:
type: object
properties:
services:
type: array
items:
type: string
nullable: true
description: "The requested carrier service for the shipment.
\n \
\ Please consult [the reference](#operation/references) for specific\
\ carriers services.
\n **Note that this is a list because\
\ on a Multi-carrier rate request you could\n specify a service\
\ per carrier.**\n "
carrier_ids:
type: array
items:
type: string
nullable: true
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 "
reference:
type: string
nullable: true
description: The shipment reference
metadata:
type: object
additionalProperties: {}
description: User metadata for the shipment
ShipmentUpdateData:
type: object
properties:
label_type:
enum:
- PDF
- ZPL
- PNG
type: string
default: PDF
description: |-
The shipment label file type.
* `PDF` - PDF
* `ZPL` - ZPL
* `PNG` - PNG
payment:
allOf:
- $ref: '#/components/schemas/Payment'
description: The payment details
options:
type: object
additionalProperties: {}
description: "\n The options available for the\
\ shipment.
\n\n {\n \"currency\": \"USD\"\
,\n \"insurance\": 100.00,\n \"cash_on_delivery\"\
: 30.00,\n \"shipment_date\": \"2020-01-01\",\n \
\ \"dangerous_good\": true,\n \"declared_value\": 150.00,\n\
\ \"email_notification\": true,\n \"email_notification_to\"\
: \"shipper@mail.com\",\n \"signature_confirmation\": true,\n\
\ }\n "
reference:
type: string
nullable: true
description: The shipment reference
metadata:
type: object
additionalProperties: {}
description: User metadata for the shipment
ShippingRequest:
type: object
properties:
shipper:
allOf:
- $ref: '#/components/schemas/AddressData'
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/AddressData'
description: "The address of the party.
\n Origin address (ship\
\ from) for the **shipper**
\n Destination address (ship to)\
\ for the **recipient**\n "
parcels:
type: array
items:
$ref: '#/components/schemas/ParcelData'
description: The shipment's parcels
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 \"shipment_date\": \"2020-01-01\",\n \
\ \"dangerous_good\": true,\n \"declared_value\": 150.00,\n\
\ \"email_notification\": true,\n \"email_notification_to\"\
: \"shipper@mail.com\",\n \"signature_confirmation\": true,\n\
\ \"preferred_service\": \"fedex_express_saver\",\n \
\ }\n "
payment:
allOf:
- $ref: '#/components/schemas/Payment'
default:
paid_by: sender
currency: null
account_number: null
description: The payment details
billing_address:
allOf:
- $ref: '#/components/schemas/AddressData'
nullable: true
description: The payor address.
customs:
allOf:
- $ref: '#/components/schemas/CustomsData'
nullable: true
description: "The customs details.
\n **Note that this is required\
\ for the shipment of an international Dutiable parcel.**\n "
reference:
type: string
nullable: true
description: The shipment reference
maxLength: 35
label_type:
enum:
- PDF
- ZPL
- PNG
type: string
default: PDF
description: |-
The shipment label file type.
* `PDF` - PDF
* `ZPL` - ZPL
* `PNG` - PNG
selected_rate_id:
type: string
description: The shipment selected rate.
rates:
type: array
items:
$ref: '#/components/schemas/Rate'
description: The list for shipment rates fetched previously
required:
- parcels
- rates
- recipient
- selected_rate_id
- shipper
ShippingResponse:
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
format: uri
nullable: true
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 "
parcels:
type: array
items:
$ref: '#/components/schemas/Parcel'
description: The shipment's parcels
services:
type: array
items:
type: string
nullable: true
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 \"shipment_date\": \"2020-01-01\",\n \
\ \"dangerous_good\": true,\n \"declared_value\": 150.00,\n\
\ \"email_notification\": true,\n \"email_notification_to\"\
: \"shipper@mail.com\",\n \"signature_confirmation\": true,\n\
\ \"preferred_service\": \"fedex_express_saver\",\n \
\ }\n "
payment:
allOf:
- $ref: '#/components/schemas/Payment'
default:
paid_by: sender
currency: null
account_number: null
description: The payment details
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
nullable: true
description: The payor address.
customs:
allOf:
- $ref: '#/components/schemas/Customs'
nullable: true
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
nullable: true
description: The shipment reference
label_type:
enum:
- PDF
- ZPL
- PNG
- ''
- null
type: string
nullable: true
description: |-
The shipment label file type.
* `PDF` - PDF
* `ZPL` - ZPL
* `PNG` - PNG
carrier_ids:
type: array
items:
type: string
nullable: true
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
nullable: true
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
status:
enum:
- draft
- purchased
- cancelled
- shipped
- in_transit
- delivered
type: string
default: draft
description: |-
The current Shipment status
* `draft` - draft
* `purchased` - purchased
* `cancelled` - cancelled
* `shipped` - shipped
* `in_transit` - in_transit
* `delivered` - delivered
carrier_name:
type: string
nullable: true
description: The shipment carrier
carrier_id:
type: string
nullable: true
description: The shipment carrier configured identifier
tracking_number:
type: string
nullable: true
description: The shipment tracking number
shipment_identifier:
type: string
nullable: true
description: The shipment carrier system identifier
selected_rate:
allOf:
- $ref: '#/components/schemas/Rate'
nullable: true
description: The shipment selected rate
docs:
allOf:
- $ref: '#/components/schemas/Documents'
nullable: true
description: The shipment documents
meta:
type: object
additionalProperties: {}
nullable: true
description: provider specific metadata
service:
type: string
nullable: true
description: The selected service
selected_rate_id:
type: string
nullable: true
description: The shipment selected rate.
test_mode:
type: boolean
description: Specified whether it was created with a carrier in test mode
required:
- created_at
- parcels
- recipient
- shipper
- test_mode
TokenObtainPair:
type: object
properties:
email:
type: string
password:
type: string
writeOnly: true
required:
- email
- password
TokenPair:
type: object
properties:
access:
type: string
refresh:
type: string
required:
- access
- refresh
TokenRefresh:
type: object
properties:
refresh:
type: string
access:
type: string
readOnly: true
required:
- access
- refresh
TokenVerify:
type: object
properties:
token:
type: string
writeOnly: true
required:
- token
TrackerList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/TrackingStatus'
required:
- results
TrackerUpdateData:
type: object
properties:
info:
allOf:
- $ref: '#/components/schemas/TrackingInfo'
nullable: true
description: The package and shipment tracking details
metadata:
type: object
additionalProperties: {}
description: User metadata for the tracker
TrackingData:
type: object
properties:
tracking_number:
type: string
description: The package tracking number
carrier_name:
enum:
- amazon_mws
- aramex
- australiapost
- canadapost
- canpar
- chronopost
- dhl_express
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- fedex
- generic
- purolator
- royalmail
- sendle
- sf_express
- tnt
- ups
- ups_freight
- usps
- usps_international
- yanwen
- yunexpress
type: string
description: |-
The tracking carrier
* `amazon_mws` - amazon_mws
* `aramex` - aramex
* `australiapost` - australiapost
* `canadapost` - canadapost
* `canpar` - canpar
* `chronopost` - chronopost
* `dhl_express` - dhl_express
* `dhl_poland` - dhl_poland
* `dhl_universal` - dhl_universal
* `dicom` - dicom
* `dpd` - dpd
* `dpdhl` - dpdhl
* `fedex` - fedex
* `generic` - generic
* `purolator` - purolator
* `royalmail` - royalmail
* `sendle` - sendle
* `sf_express` - sf_express
* `tnt` - tnt
* `ups` - ups
* `ups_freight` - ups_freight
* `usps` - usps
* `usps_international` - usps_international
* `yanwen` - yanwen
* `yunexpress` - yunexpress
account_number:
type: string
nullable: true
description: The shipper account number
reference:
type: string
nullable: true
description: The shipment reference
info:
allOf:
- $ref: '#/components/schemas/TrackingInfo'
nullable: true
description: The package and shipment tracking details
required:
- carrier_name
- tracking_number
TrackingEvent:
type: object
properties:
date:
type: string
description: The tracking event's date
description:
type: string
description: The tracking event's description
location:
type: string
description: The tracking event's location
code:
type: string
nullable: true
description: The tracking event's code
time:
type: string
nullable: true
description: The tracking event's time
latitude:
type: number
format: double
nullable: true
description: The tracking event's latitude.
longitude:
type: number
format: double
nullable: true
description: The tracking event's longitude.
TrackingInfo:
type: object
properties:
carrier_tracking_link:
type: string
nullable: true
description: The carrier tracking link
customer_name:
type: string
nullable: true
description: The customer name
expected_delivery:
type: string
nullable: true
description: The expected delivery date
note:
type: string
nullable: true
description: A tracking note
order_date:
type: string
nullable: true
description: The package order date
order_id:
type: string
nullable: true
description: The package order id or number
package_weight:
type: string
nullable: true
description: The package weight
package_weight_unit:
type: string
nullable: true
description: The package weight unit
shipment_package_count:
type: string
nullable: true
description: The package count
shipment_pickup_date:
type: string
nullable: true
description: The shipment pickup date
shipment_delivery_date:
type: string
nullable: true
description: The shipment delivery date
shipment_service:
type: string
nullable: true
description: The shipment service
shipment_origin_country:
type: string
nullable: true
description: The shipment origin country
shipment_origin_postal_code:
type: string
nullable: true
description: The shipment origin postal code
shipment_destication_country:
type: string
nullable: true
description: The shipment destination country
shipment_destination_postal_code:
type: string
nullable: true
description: The shipment destination postal code
shipping_date:
type: string
nullable: true
description: The shipping date
signed_by:
type: string
nullable: true
description: The person who signed for the package
source:
type: string
nullable: true
description: The tracker source
TrackingResponse:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Message'
description: The list of note or warning messages
tracking:
allOf:
- $ref: '#/components/schemas/TrackingStatus'
description: The tracking details retrieved
TrackingStatus:
type: object
properties:
id:
type: string
description: A unique identifier
carrier_name:
type: string
description: The tracking carrier
carrier_id:
type: string
description: The tracking carrier configured identifier
tracking_number:
type: string
description: The shipment tracking number
info:
allOf:
- $ref: '#/components/schemas/TrackingInfo'
nullable: true
default:
carrier_tracking_link: null
customer_name: null
expected_delivery: null
note: null
order_date: null
order_id: null
package_weight: null
package_weight_unit: null
shipment_package_count: null
shipment_pickup_date: null
shipment_delivery_date: null
shipment_service: null
shipment_origin_country: null
shipment_origin_postal_code: null
shipment_destication_country: null
shipment_destination_postal_code: null
shipping_date: null
signed_by: null
source: null
description: The package and shipment tracking details
events:
type: array
items:
$ref: '#/components/schemas/TrackingEvent'
nullable: true
description: The tracking details events
delivered:
type: boolean
description: Specified whether the related shipment was delivered
test_mode:
type: boolean
description: Specified whether the object was created with a carrier in
test mode
status:
enum:
- pending
- unknown
- delivered
- on_hold
- in_transit
- delivery_delayed
- out_for_delivery
- ready_for_pickup
- delivery_failed
type: string
default: pending
description: |-
The current tracking status
* `pending` - pending
* `unknown` - unknown
* `delivered` - delivered
* `on_hold` - on_hold
* `in_transit` - in_transit
* `delivery_delayed` - delivery_delayed
* `out_for_delivery` - out_for_delivery
* `ready_for_pickup` - ready_for_pickup
* `delivery_failed` - delivery_failed
estimated_delivery:
type: string
description: The delivery estimated date
meta:
type: object
additionalProperties: {}
nullable: true
description: provider specific metadata
object_type:
type: string
default: tracker
description: Specifies the object type
metadata:
type: object
additionalProperties: {}
default: {}
description: User metadata for the tracker
messages:
type: array
items:
$ref: '#/components/schemas/Message'
default: []
description: The list of note or warning messages
required:
- carrier_id
- carrier_name
- test_mode
- tracking_number
VerifiedTokenObtainPair:
type: object
properties:
refresh:
type: string
access:
type: string
readOnly: true
otp_token:
type: string
description: "The OTP (One Time Password) token received by the user from\
\ the\n configured Two Factor Authentication method.\n "
required:
- access
- otp_token
- refresh
Webhook:
type: object
properties:
id:
type: string
description: A unique identifier
url:
type: string
format: uri
description: The URL of the webhook endpoint.
description:
type: string
nullable: true
description: An optional description of what the webhook is used for.
enabled_events:
type: array
items:
enum:
- all
- shipment_purchased
- shipment_cancelled
- shipment_fulfilled
- tracker_created
- tracker_updated
- order_created
- order_updated
- order_fulfilled
- order_cancelled
- order_delivered
- batch_queued
- batch_failed
- batch_running
- batch_completed
type: string
description: |-
* `all` - all
* `shipment_purchased` - shipment_purchased
* `shipment_cancelled` - shipment_cancelled
* `shipment_fulfilled` - shipment_fulfilled
* `tracker_created` - tracker_created
* `tracker_updated` - tracker_updated
* `order_created` - order_created
* `order_updated` - order_updated
* `order_fulfilled` - order_fulfilled
* `order_cancelled` - order_cancelled
* `order_delivered` - order_delivered
* `batch_queued` - batch_queued
* `batch_failed` - batch_failed
* `batch_running` - batch_running
* `batch_completed` - batch_completed
description: The list of events to enable for this endpoint.
disabled:
type: boolean
nullable: true
description: Indicates that the webhook is disabled
object_type:
type: string
default: webhook
description: Specifies the object type
last_event_at:
type: string
format: date-time
nullable: true
description: The datetime of the last event sent.
secret:
type: string
description: Header signature secret
test_mode:
type: boolean
description: Specified whether it was created with a carrier in test mode
required:
- enabled_events
- secret
- test_mode
- url
WebhookData:
type: object
properties:
url:
type: string
format: uri
description: The URL of the webhook endpoint.
description:
type: string
nullable: true
description: An optional description of what the webhook is used for.
enabled_events:
type: array
items:
enum:
- all
- shipment_purchased
- shipment_cancelled
- shipment_fulfilled
- tracker_created
- tracker_updated
- order_created
- order_updated
- order_fulfilled
- order_cancelled
- order_delivered
- batch_queued
- batch_failed
- batch_running
- batch_completed
type: string
description: |-
* `all` - all
* `shipment_purchased` - shipment_purchased
* `shipment_cancelled` - shipment_cancelled
* `shipment_fulfilled` - shipment_fulfilled
* `tracker_created` - tracker_created
* `tracker_updated` - tracker_updated
* `order_created` - order_created
* `order_updated` - order_updated
* `order_fulfilled` - order_fulfilled
* `order_cancelled` - order_cancelled
* `order_delivered` - order_delivered
* `batch_queued` - batch_queued
* `batch_failed` - batch_failed
* `batch_running` - batch_running
* `batch_completed` - batch_completed
description: The list of events to enable for this endpoint.
disabled:
type: boolean
nullable: true
description: Indicates that the webhook is disabled
required:
- enabled_events
- url
WebhookList:
type: object
properties:
count:
type: integer
nullable: true
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Webhook'
required:
- results
WebhookTestRequest:
type: object
properties:
payload:
type: object
additionalProperties: {}
required:
- payload
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: Reading scope
write: Writing scope
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:'
tags:
- name: API
description: "API instance metadata and authentication resources.\n \
\ "
- name: Carriers
description: "This is an object representing your a Karrio carrier account connectsions.\n\
\ You can retrieve all configured connections available to your\
\ Karrio account.\n The `carrier_id` is a nickname you assign to\
\ your connection.\n "
- name: Addresses
description: "This is an object representing your a Karrio shipping address.\n \
\ You can retrieve all addresses related to your Karrio account.\n\
\ Address objects are linked to your shipment history, and can\
\ be used for recurring shipping\n to / from the same locations.\n\
\ "
- name: Parcels
description: "This is an object representing your a Karrio shipping parcel.\n \
\ Parcel objects are linked to your shipment history, and can be\
\ used for recurring shipping\n using the same packaging.\n \
\ "
- name: Customs
description: "This is an object representing your a Karrio shipping customs declaration.\n\
\ You can retrieve all customs declarations used historically with\
\ your Karrio account shipments.\n "
- name: Shipments
description: "This is an object representing your a Karrio shipment.\n \
\ A Shipment guides you through process of preparing and purchasing a label\
\ for an order.\n A Shipment transitions through multiple statuses\
\ throughout its lifetime as the package\n shipped makes its journey\
\ to it's destination.\n "
- name: Documents
description: "This is an object representing your a Karrio document upload record.\n\
\ A Document upload record keep traces of shipping trade documents\
\ uploaded to carriers\n to fast track customs processing.\n \
\ "
- name: Trackers
description: "This is an object representing your a Karrio shipment tracker.\n \
\ A shipment tracker is an object attached to a shipment by it's\
\ tracking number.\n The tracker provide the latest tracking status\
\ and events associated with a shipment\n "
- name: Pickups
description: "This is an object representing your a Karrio pickup booking.\n \
\ You can retrieve all pickup booked historically for your Karrio\
\ account shipments.\n "
- name: Proxy
description: "In some scenarios, all we need is to send request to a carrier using\
\ the Karrio unified API.\n The Proxy API comes handy for that\
\ as it turn Karrio into a simple middleware that converts and\n \
\ validate your request and simply forward it to the shipping carrier server.
\n\
\ **Note:**
\n When using the proxy API,\
\ no objects are created in the Karrio system.\n "
- name: Orders
description: "This is an object representing your a Karrio order.\n \
\ You can create Karrio orders to organize your shipments and ship line items\
\ separately.\n "
- name: Webhooks
description: "This is an object representing your a Karrio webhook.\n \
\ You can configure webhook endpoints via the API to be notified about events\
\ that happen in your\n Karrio account.\n "
- name: Batches
description: "This is an object representing your a Karrio batch operation.\n \
\ You can retrieve all batch operations historically for your Karrio\
\ account.\n "
- name: Reference & Enums
description: |+
## Carriers
| Carrier Name | Display Name |
| ------------ | ------------ |
| amazon_mws | AmazonMws |
| aramex | Aramex |
| australiapost | Australia Post |
| canadapost | Canada Post |
| canpar | Canpar |
| chronopost | Chronopost |
| dhl_poland | DHL Parcel Poland |
| dhl_universal | DHL Universal |
| dicom | Dicom |
| dpd | DPD |
| easypost | EasyPost |
| eshipper | eShipper |
| fedex | FedEx |
| freightcom | Freightcom |
| purolator | Purolator |
| royalmail | Royal Mail |
| sendle | Sendle |
| sf_express | SF-Express |
| tnt | TNT |
| ups | UPS |
| ups_freight | UPS Freight |
| usps | USPS |
| usps_international | USPS International |
| yanwen | Yanwen |
| yunexpress | Yunexpress |
| dhl_express | DHL Express |
| dpdhl | Deutsche Post DHL |
---
## Services
The following service level codes can be used to reference specific rates
when purchasing shipping labels using single call label creation.
You can also find all of the possible service levels for each of your carrier
accounts by using [this endpoint](#operation/&&get_services).
### AmazonMws
| Code | Service Name |
| ------------ | ------------ |
| amazon_shipping_ground | Amazon Shipping Ground |
| amazon_shipping_standard | Amazon Shipping Standard |
| amazon_shipping_premium | Amazon Shipping Premium |
### Canada Post
| Code | Service Name |
| ------------ | ------------ |
| canadapost_regular_parcel | DOM.RP |
| canadapost_expedited_parcel | DOM.EP |
| canadapost_xpresspost | DOM.XP |
| canadapost_xpresspost_certified | DOM.XP.CERT |
| canadapost_priority | DOM.PC |
| canadapost_library_books | DOM.LIB |
| canadapost_expedited_parcel_usa | USA.EP |
| canadapost_priority_worldwide_envelope_usa | USA.PW.ENV |
| canadapost_priority_worldwide_pak_usa | USA.PW.PAK |
| canadapost_priority_worldwide_parcel_usa | USA.PW.PARCEL |
| canadapost_small_packet_usa_air | USA.SP.AIR |
| canadapost_tracked_packet_usa | USA.TP |
| canadapost_tracked_packet_usa_lvm | USA.TP.LVM |
| canadapost_xpresspost_usa | USA.XP |
| canadapost_xpresspost_international | INT.XP |
| canadapost_international_parcel_air | INT.IP.AIR |
| canadapost_international_parcel_surface | INT.IP.SURF |
| canadapost_priority_worldwide_envelope_intl | INT.PW.ENV |
| canadapost_priority_worldwide_pak_intl | INT.PW.PAK |
| canadapost_priority_worldwide_parcel_intl | INT.PW.PARCEL |
| canadapost_small_packet_international_air | INT.SP.AIR |
| canadapost_small_packet_international_surface | INT.SP.SURF |
| canadapost_tracked_packet_international | INT.TP |
### Chronopost
| Code | Service Name |
| ------------ | ------------ |
| chronopost_retrait_bureau | 0 |
| chronopost_13 | 1 |
| chronopost_10 | 2 |
| chronopost_18 | 16 |
| chronopost_relais | 86 |
| chronopost_express_international | 17 |
| chronopost_premium_international | 37 |
| chronopost_classic_international | 44 |
### DHL Parcel Poland
| Code | Service Name |
| ------------ | ------------ |
| dhl_poland_premium | PR |
| dhl_poland_polska | AH |
| dhl_poland_09 | 09 |
| dhl_poland_12 | 12 |
| dhl_poland_connect | EK |
| dhl_poland_international | PI |
### EasyPost
| Code | Service Name |
| ------------ | ------------ |
| easypost_amazonmws_ups_rates | UPS Rates |
| easypost_amazonmws_usps_rates | USPS Rates |
| easypost_amazonmws_fedex_rates | FedEx Rates |
| easypost_amazonmws_ups_labels | UPS Labels |
| easypost_amazonmws_usps_labels | USPS Labels |
| easypost_amazonmws_fedex_labels | FedEx Labels |
| easypost_amazonmws_ups_tracking | UPS Tracking |
| easypost_amazonmws_usps_tracking | USPS Tracking |
| easypost_amazonmws_fedex_tracking | FedEx Tracking |
| easypost_apc_parcel_connect_book_service | parcelConnectBookService |
| easypost_apc_parcel_connect_expedited_ddp | parcelConnectExpeditedDDP |
| easypost_apc_parcel_connect_expedited_ddu | parcelConnectExpeditedDDU |
| easypost_apc_parcel_connect_priority_ddp | parcelConnectPriorityDDP |
| easypost_apc_parcel_connect_priority_ddp_delcon | parcelConnectPriorityDDPDelcon |
| easypost_apc_parcel_connect_priority_ddu | parcelConnectPriorityDDU |
| easypost_apc_parcel_connect_priority_ddu_delcon | parcelConnectPriorityDDUDelcon |
| easypost_apc_parcel_connect_priority_ddupqw | parcelConnectPriorityDDUPQW |
| easypost_apc_parcel_connect_standard_ddu | parcelConnectStandardDDU |
| easypost_apc_parcel_connect_standard_ddupqw | parcelConnectStandardDDUPQW |
| easypost_apc_parcel_connect_packet_ddu | parcelConnectPacketDDU |
| easypost_asendia_pmi | PMI |
| easypost_asendia_e_packet | ePacket |
| easypost_asendia_ipa | IPA |
| easypost_asendia_isal | ISAL |
| easypost_asendia_us_ads | ADS |
| easypost_asendia_us_air_freight_inbound | AirFreightInbound |
| easypost_asendia_us_air_freight_outbound | AirFreightOutbound |
| easypost_asendia_us_domestic_bound_printer_matter_expedited | AsendiaDomesticBoundPrinterMatterExpedited |
| easypost_asendia_us_domestic_bound_printer_matter_ground | AsendiaDomesticBoundPrinterMatterGround |
| easypost_asendia_us_domestic_flats_expedited | AsendiaDomesticFlatsExpedited |
| easypost_asendia_us_domestic_flats_ground | AsendiaDomesticFlatsGround |
| easypost_asendia_us_domestic_parcel_ground_over1lb | AsendiaDomesticParcelGroundOver1lb |
| easypost_asendia_us_domestic_parcel_ground_under1lb | AsendiaDomesticParcelGroundUnder1lb |
| easypost_asendia_us_domestic_parcel_max_over1lb | AsendiaDomesticParcelMAXOver1lb |
| easypost_asendia_us_domestic_parcel_max_under1lb | AsendiaDomesticParcelMAXUnder1lb |
| easypost_asendia_us_domestic_parcel_over1lb_expedited | AsendiaDomesticParcelOver1lbExpedited |
| easypost_asendia_us_domestic_parcel_under1lb_expedited | AsendiaDomesticParcelUnder1lbExpedited |
| easypost_asendia_us_domestic_promo_parcel_expedited | AsendiaDomesticPromoParcelExpedited |
| easypost_asendia_us_domestic_promo_parcel_ground | AsendiaDomesticPromoParcelGround |
| easypost_asendia_us_bulk_freight | BulkFreight |
| easypost_asendia_us_business_mail_canada_lettermail | BusinessMailCanadaLettermail |
| easypost_asendia_us_business_mail_canada_lettermail_machineable | BusinessMailCanadaLettermailMachineable |
| easypost_asendia_us_business_mail_economy | BusinessMailEconomy |
| easypost_asendia_us_business_mail_economy_lp_wholesale | BusinessMailEconomyLPWholesale |
| easypost_asendia_us_business_mail_economy_sp_wholesale | BusinessMailEconomySPWholesale |
| easypost_asendia_us_business_mail_ipa | BusinessMailIPA |
| easypost_asendia_us_business_mail_isal | BusinessMailISAL |
| easypost_asendia_us_business_mail_priority | BusinessMailPriority |
| easypost_asendia_us_business_mail_priority_lp_wholesale | BusinessMailPriorityLPWholesale |
| easypost_asendia_us_business_mail_priority_sp_wholesale | BusinessMailPrioritySPWholesale |
| easypost_asendia_us_marketing_mail_canada_personalized_lcp | MarketingMailCanadaPersonalizedLCP |
| easypost_asendia_us_marketing_mail_canada_personalized_machineable | MarketingMailCanadaPersonalizedMachineable |
| easypost_asendia_us_marketing_mail_canada_personalized_ndg | MarketingMailCanadaPersonalizedNDG |
| easypost_asendia_us_marketing_mail_economy | MarketingMailEconomy |
| easypost_asendia_us_marketing_mail_ipa | MarketingMailIPA |
| easypost_asendia_us_marketing_mail_isal | MarketingMailISAL |
| easypost_asendia_us_marketing_mail_priority | MarketingMailPriority |
| easypost_asendia_us_publications_canada_lcp | PublicationsCanadaLCP |
| easypost_asendia_us_publications_canada_ndg | PublicationsCanadaNDG |
| easypost_asendia_us_publications_economy | PublicationsEconomy |
| easypost_asendia_us_publications_ipa | PublicationsIPA |
| easypost_asendia_us_publications_isal | PublicationsISAL |
| easypost_asendia_us_publications_priority | PublicationsPriority |
| easypost_asendia_us_epaq_elite | ePAQElite |
| easypost_asendia_us_epaq_elite_custom | ePAQEliteCustom |
| easypost_asendia_us_epaq_elite_dap | ePAQEliteDAP |
| easypost_asendia_us_epaq_elite_ddp | ePAQEliteDDP |
| easypost_asendia_us_epaq_elite_ddp_oversized | ePAQEliteDDPOversized |
| easypost_asendia_us_epaq_elite_dpd | ePAQEliteDPD |
| easypost_asendia_us_epaq_elite_direct_access_canada_ddp | ePAQEliteDirectAccessCanadaDDP |
| easypost_asendia_us_epaq_elite_oversized | ePAQEliteOversized |
| easypost_asendia_us_epaq_plus | ePAQPlus |
| easypost_asendia_us_epaq_plus_custom | ePAQPlusCustom |
| easypost_asendia_us_epaq_plus_customs_prepaid | ePAQPlusCustomsPrepaid |
| easypost_asendia_us_epaq_plus_dap | ePAQPlusDAP |
| easypost_asendia_us_epaq_plus_ddp | ePAQPlusDDP |
| easypost_asendia_us_epaq_plus_economy | ePAQPlusEconomy |
| easypost_asendia_us_epaq_plus_wholesale | ePAQPlusWholesale |
| easypost_asendia_us_epaq_pluse_packet | ePAQPlusePacket |
| easypost_asendia_us_epaq_pluse_packet_canada_customs_pre_paid | ePAQPlusePacketCanadaCustomsPrePaid |
| easypost_asendia_us_epaq_pluse_packet_canada_ddp | ePAQPlusePacketCanadaDDP |
| easypost_asendia_us_epaq_returns_domestic | ePAQReturnsDomestic |
| easypost_asendia_us_epaq_returns_international | ePAQReturnsInternational |
| easypost_asendia_us_epaq_select | ePAQSelect |
| easypost_asendia_us_epaq_select_custom | ePAQSelectCustom |
| easypost_asendia_us_epaq_select_customs_prepaid_by_shopper | ePAQSelectCustomsPrepaidByShopper |
| easypost_asendia_us_epaq_select_dap | ePAQSelectDAP |
| easypost_asendia_us_epaq_select_ddp | ePAQSelectDDP |
| easypost_asendia_us_epaq_select_ddp_direct_access | ePAQSelectDDPDirectAccess |
| easypost_asendia_us_epaq_select_direct_access | ePAQSelectDirectAccess |
| easypost_asendia_us_epaq_select_direct_access_canada_ddp | ePAQSelectDirectAccessCanadaDDP |
| easypost_asendia_us_epaq_select_economy | ePAQSelectEconomy |
| easypost_asendia_us_epaq_select_oversized | ePAQSelectOversized |
| easypost_asendia_us_epaq_select_oversized_ddp | ePAQSelectOversizedDDP |
| easypost_asendia_us_epaq_select_pmei | ePAQSelectPMEI |
| easypost_asendia_us_epaq_select_pmei_canada_customs_pre_paid | ePAQSelectPMEICanadaCustomsPrePaid |
| easypost_asendia_us_epaq_select_pmeipc_postage | ePAQSelectPMEIPCPostage |
| easypost_asendia_us_epaq_select_pmi | ePAQSelectPMI |
| easypost_asendia_us_epaq_select_pmi_canada_customs_prepaid | ePAQSelectPMICanadaCustomsPrepaid |
| easypost_asendia_us_epaq_select_pmi_canada_ddp | ePAQSelectPMICanadaDDP |
| easypost_asendia_us_epaq_select_pmi_non_presort | ePAQSelectPMINonPresort |
| easypost_asendia_us_epaq_select_pmipc_postage | ePAQSelectPMIPCPostage |
| easypost_asendia_us_epaq_standard | ePAQStandard |
| easypost_asendia_us_epaq_standard_custom | ePAQStandardCustom |
| easypost_asendia_us_epaq_standard_economy | ePAQStandardEconomy |
| easypost_asendia_us_epaq_standard_ipa | ePAQStandardIPA |
| easypost_asendia_us_epaq_standard_isal | ePAQStandardISAL |
| easypost_asendia_us_epaq_select_pmei_non_presort | ePaqSelectPMEINonPresort |
| easypost_australiapost_express_post | ExpressPost |
| easypost_australiapost_express_post_signature | ExpressPostSignature |
| easypost_australiapost_parcel_post | ParcelPost |
| easypost_australiapost_parcel_post_signature | ParcelPostSignature |
| easypost_australiapost_parcel_post_extra | ParcelPostExtra |
| easypost_australiapost_parcel_post_wine_plus_signature | ParcelPostWinePlusSignature |
| easypost_axlehire_delivery | AxleHireDelivery |
| easypost_better_trucks_next_day | NEXT_DAY |
| easypost_bond_standard | Standard |
| easypost_canadapost_regular_parcel | RegularParcel |
| easypost_canadapost_expedited_parcel | ExpeditedParcel |
| easypost_canadapost_xpresspost | Xpresspost |
| easypost_canadapost_xpresspost_certified | XpresspostCertified |
| easypost_canadapost_priority | Priority |
| easypost_canadapost_library_books | LibraryBooks |
| easypost_canadapost_expedited_parcel_usa | ExpeditedParcelUSA |
| easypost_canadapost_priority_worldwide_envelope_usa | PriorityWorldwideEnvelopeUSA |
| easypost_canadapost_priority_worldwide_pak_usa | PriorityWorldwidePakUSA |
| easypost_canadapost_priority_worldwide_parcel_usa | PriorityWorldwideParcelUSA |
| easypost_canadapost_small_packet_usa_air | SmallPacketUSAAir |
| easypost_canadapost_tracked_packet_usa | TrackedPacketUSA |
| easypost_canadapost_tracked_packet_usalvm | TrackedPacketUSALVM |
| easypost_canadapost_xpresspost_usa | XpresspostUSA |
| easypost_canadapost_xpresspost_international | XpresspostInternational |
| easypost_canadapost_international_parcel_air | InternationalParcelAir |
| easypost_canadapost_international_parcel_surface | InternationalParcelSurface |
| easypost_canadapost_priority_worldwide_envelope_intl | PriorityWorldwideEnvelopeIntl |
| easypost_canadapost_priority_worldwide_pak_intl | PriorityWorldwidePakIntl |
| easypost_canadapost_priority_worldwide_parcel_intl | PriorityWorldwideParcelIntl |
| easypost_canadapost_small_packet_international_air | SmallPacketInternationalAir |
| easypost_canadapost_small_packet_international_surface | SmallPacketInternationalSurface |
| easypost_canadapost_tracked_packet_international | TrackedPacketInternational |
| easypost_canpar_ground | Ground |
| easypost_canpar_select_letter | SelectLetter |
| easypost_canpar_select_pak | SelectPak |
| easypost_canpar_select | Select |
| easypost_canpar_overnight_letter | OvernightLetter |
| easypost_canpar_overnight_pak | OvernightPak |
| easypost_canpar_overnight | Overnight |
| easypost_canpar_select_usa | SelectUSA |
| easypost_canpar_usa_pak | USAPak |
| easypost_canpar_usa_letter | USALetter |
| easypost_canpar_usa | USA |
| easypost_canpar_international | International |
| easypost_cdl_distribution | DISTRIBUTION |
| easypost_cdl_same_day | Same Day |
| easypost_courier_express_basic_parcel | BASIC_PARCEL |
| easypost_couriersplease_domestic_priority_signature | DomesticPrioritySignature |
| easypost_couriersplease_domestic_priority | DomesticPriority |
| easypost_couriersplease_domestic_off_peak_signature | DomesticOffPeakSignature |
| easypost_couriersplease_domestic_off_peak | DomesticOffPeak |
| easypost_couriersplease_gold_domestic_signature | GoldDomesticSignature |
| easypost_couriersplease_gold_domestic | GoldDomestic |
| easypost_couriersplease_australian_city_express_signature | AustralianCityExpressSignature |
| easypost_couriersplease_australian_city_express | AustralianCityExpress |
| easypost_couriersplease_domestic_saver_signature | DomesticSaverSignature |
| easypost_couriersplease_domestic_saver | DomesticSaver |
| easypost_couriersplease_road_express | RoadExpress |
| easypost_couriersplease_5_kg_satchel | 5KgSatchel |
| easypost_couriersplease_3_kg_satchel | 3KgSatchel |
| easypost_couriersplease_1_kg_satchel | 1KgSatchel |
| easypost_couriersplease_5_kg_satchel_atl | 5KgSatchelATL |
| easypost_couriersplease_3_kg_satchel_atl | 3KgSatchelATL |
| easypost_couriersplease_1_kg_satchel_atl | 1KgSatchelATL |
| easypost_couriersplease_500_gram_satchel | 500GramSatchel |
| easypost_couriersplease_500_gram_satchel_atl | 500GramSatchelATL |
| easypost_couriersplease_25_kg_parcel | 25KgParcel |
| easypost_couriersplease_10_kg_parcel | 10KgParcel |
| easypost_couriersplease_5_kg_parcel | 5KgParcel |
| easypost_couriersplease_3_kg_parcel | 3KgParcel |
| easypost_couriersplease_1_kg_parcel | 1KgParcel |
| easypost_couriersplease_500_gram_parcel | 500GramParcel |
| easypost_couriersplease_500_gram_parcel_atl | 500GramParcelATL |
| easypost_couriersplease_express_international_priority | ExpressInternationalPriority |
| easypost_couriersplease_international_saver | InternationalSaver |
| easypost_couriersplease_international_express_import | InternationalExpressImport |
| easypost_couriersplease_domestic_tracked | DomesticTracked |
| easypost_couriersplease_international_economy | InternationalEconomy |
| easypost_couriersplease_international_standard | InternationalStandard |
| easypost_couriersplease_international_express | InternationalExpress |
| easypost_deutschepost_packet_plus | PacketPlus |
| easypost_deutschepost_uk_priority_packet_plus | PriorityPacketPlus |
| easypost_deutschepost_uk_priority_packet | PriorityPacket |
| easypost_deutschepost_uk_priority_packet_tracked | PriorityPacketTracked |
| easypost_deutschepost_uk_business_mail_registered | BusinessMailRegistered |
| easypost_deutschepost_uk_standard_packet | StandardPacket |
| easypost_deutschepost_uk_business_mail_standard | BusinessMailStandard |
| easypost_dhl_ecom_asia_packet | Packet |
| easypost_dhl_ecom_asia_parcel_direct | ParcelDirect |
| easypost_dhl_ecom_asia_parcel_direct_expedited | ParcelDirectExpedited |
| easypost_dhl_ecom_parcel_expedited | DHLParcelExpedited |
| easypost_dhl_ecom_parcel_expedited_max | DHLParcelExpeditedMax |
| easypost_dhl_ecom_parcel_ground | DHLParcelGround |
| easypost_dhl_ecom_bpm_expedited | DHLBPMExpedited |
| easypost_dhl_ecom_bpm_ground | DHLBPMGround |
| easypost_dhl_ecom_parcel_international_direct | DHLParcelInternationalDirect |
| easypost_dhl_ecom_parcel_international_standard | DHLParcelInternationalStandard |
| easypost_dhl_ecom_packet_international | DHLPacketInternational |
| easypost_dhl_ecom_parcel_international_direct_priority | DHLParcelInternationalDirectPriority |
| easypost_dhl_ecom_parcel_international_direct_standard | DHLParcelInternationalDirectStandard |
| easypost_dhl_express_break_bulk_economy | BreakBulkEconomy |
| easypost_dhl_express_break_bulk_express | BreakBulkExpress |
| easypost_dhl_express_domestic_economy_select | DomesticEconomySelect |
| easypost_dhl_express_domestic_express | DomesticExpress |
| easypost_dhl_express_domestic_express1030 | DomesticExpress1030 |
| easypost_dhl_express_domestic_express1200 | DomesticExpress1200 |
| easypost_dhl_express_economy_select | EconomySelect |
| easypost_dhl_express_economy_select_non_doc | EconomySelectNonDoc |
| easypost_dhl_express_euro_pack | EuroPack |
| easypost_dhl_express_europack_non_doc | EuropackNonDoc |
| easypost_dhl_express_express1030 | Express1030 |
| easypost_dhl_express_express1030_non_doc | Express1030NonDoc |
| easypost_dhl_express_express1200_non_doc | Express1200NonDoc |
| easypost_dhl_express_express1200 | Express1200 |
| easypost_dhl_express_express900 | Express900 |
| easypost_dhl_express_express900_non_doc | Express900NonDoc |
| easypost_dhl_express_express_easy | ExpressEasy |
| easypost_dhl_express_express_easy_non_doc | ExpressEasyNonDoc |
| easypost_dhl_express_express_envelope | ExpressEnvelope |
| easypost_dhl_express_express_worldwide | ExpressWorldwide |
| easypost_dhl_express_express_worldwide_b2_c | ExpressWorldwideB2C |
| easypost_dhl_express_express_worldwide_b2_c_non_doc | ExpressWorldwideB2CNonDoc |
| easypost_dhl_express_express_worldwide_ecx | ExpressWorldwideECX |
| easypost_dhl_express_express_worldwide_non_doc | ExpressWorldwideNonDoc |
| easypost_dhl_express_freight_worldwide | FreightWorldwide |
| easypost_dhl_express_globalmail_business | GlobalmailBusiness |
| easypost_dhl_express_jet_line | JetLine |
| easypost_dhl_express_jumbo_box | JumboBox |
| easypost_dhl_express_logistics_services | LogisticsServices |
| easypost_dhl_express_same_day | SameDay |
| easypost_dhl_express_secure_line | SecureLine |
| easypost_dhl_express_sprint_line | SprintLine |
| easypost_dpd_classic | DPDCLASSIC |
| easypost_dpd_8_30 | DPD8:30 |
| easypost_dpd_10_00 | DPD10:00 |
| easypost_dpd_12_00 | DPD12:00 |
| easypost_dpd_18_00 | DPD18:00 |
| easypost_dpd_express | DPDEXPRESS |
| easypost_dpd_parcelletter | DPDPARCELLETTER |
| easypost_dpd_parcelletterplus | DPDPARCELLETTERPLUS |
| easypost_dpd_internationalmail | DPDINTERNATIONALMAIL |
| easypost_dpd_uk_air_express_international_air | AirExpressInternationalAir |
| easypost_dpd_uk_air_classic_international_air | AirClassicInternationalAir |
| easypost_dpd_uk_parcel_sunday | ParcelSunday |
| easypost_dpd_uk_freight_parcel_sunday | FreightParcelSunday |
| easypost_dpd_uk_pallet_sunday | PalletSunday |
| easypost_dpd_uk_pallet_dpd_classic | PalletDpdClassic |
| easypost_dpd_uk_expresspak_dpd_classic | ExpresspakDpdClassic |
| easypost_dpd_uk_expresspak_sunday | ExpresspakSunday |
| easypost_dpd_uk_parcel_dpd_classic | ParcelDpdClassic |
| easypost_dpd_uk_parcel_dpd_two_day | ParcelDpdTwoDay |
| easypost_dpd_uk_parcel_dpd_next_day | ParcelDpdNextDay |
| easypost_dpd_uk_parcel_dpd12 | ParcelDpd12 |
| easypost_dpd_uk_parcel_dpd10 | ParcelDpd10 |
| easypost_dpd_uk_parcel_return_to_shop | ParcelReturnToShop |
| easypost_dpd_uk_parcel_saturday | ParcelSaturday |
| easypost_dpd_uk_parcel_saturday12 | ParcelSaturday12 |
| easypost_dpd_uk_parcel_saturday10 | ParcelSaturday10 |
| easypost_dpd_uk_parcel_sunday12 | ParcelSunday12 |
| easypost_dpd_uk_freight_parcel_dpd_classic | FreightParcelDpdClassic |
| easypost_dpd_uk_freight_parcel_sunday12 | FreightParcelSunday12 |
| easypost_dpd_uk_expresspak_dpd_next_day | ExpresspakDpdNextDay |
| easypost_dpd_uk_expresspak_dpd12 | ExpresspakDpd12 |
| easypost_dpd_uk_expresspak_dpd10 | ExpresspakDpd10 |
| easypost_dpd_uk_expresspak_saturday | ExpresspakSaturday |
| easypost_dpd_uk_expresspak_saturday12 | ExpresspakSaturday12 |
| easypost_dpd_uk_expresspak_saturday10 | ExpresspakSaturday10 |
| easypost_dpd_uk_expresspak_sunday12 | ExpresspakSunday12 |
| easypost_dpd_uk_pallet_sunday12 | PalletSunday12 |
| easypost_dpd_uk_pallet_dpd_two_day | PalletDpdTwoDay |
| easypost_dpd_uk_pallet_dpd_next_day | PalletDpdNextDay |
| easypost_dpd_uk_pallet_dpd12 | PalletDpd12 |
| easypost_dpd_uk_pallet_dpd10 | PalletDpd10 |
| easypost_dpd_uk_pallet_saturday | PalletSaturday |
| easypost_dpd_uk_pallet_saturday12 | PalletSaturday12 |
| easypost_dpd_uk_pallet_saturday10 | PalletSaturday10 |
| easypost_dpd_uk_freight_parcel_dpd_two_day | FreightParcelDpdTwoDay |
| easypost_dpd_uk_freight_parcel_dpd_next_day | FreightParcelDpdNextDay |
| easypost_dpd_uk_freight_parcel_dpd12 | FreightParcelDpd12 |
| easypost_dpd_uk_freight_parcel_dpd10 | FreightParcelDpd10 |
| easypost_dpd_uk_freight_parcel_saturday | FreightParcelSaturday |
| easypost_dpd_uk_freight_parcel_saturday12 | FreightParcelSaturday12 |
| easypost_dpd_uk_freight_parcel_saturday10 | FreightParcelSaturday10 |
| easypost_epost_courier_service_ddp | CourierServiceDDP |
| easypost_epost_courier_service_ddu | CourierServiceDDU |
| easypost_epost_domestic_economy_parcel | DomesticEconomyParcel |
| easypost_epost_domestic_parcel_bpm | DomesticParcelBPM |
| easypost_epost_domestic_priority_parcel | DomesticPriorityParcel |
| easypost_epost_domestic_priority_parcel_bpm | DomesticPriorityParcelBPM |
| easypost_epost_emi_service | EMIService |
| easypost_epost_economy_parcel_service | EconomyParcelService |
| easypost_epost_ipa_service | IPAService |
| easypost_epost_isal_service | ISALService |
| easypost_epost_pmi_service | PMIService |
| easypost_epost_priority_parcel_ddp | PriorityParcelDDP |
| easypost_epost_priority_parcel_ddu | PriorityParcelDDU |
| easypost_epost_priority_parcel_delivery_confirmation_ddp | PriorityParcelDeliveryConfirmationDDP |
| easypost_epost_priority_parcel_delivery_confirmation_ddu | PriorityParcelDeliveryConfirmationDDU |
| easypost_epost_epacket_service | ePacketService |
| easypost_estafeta_next_day_by930 | NextDayBy930 |
| easypost_estafeta_next_day_by1130 | NextDayBy1130 |
| easypost_estafeta_next_day | NextDay |
| easypost_estafeta_two_day | TwoDay |
| easypost_estafeta_ltl | LTL |
| easypost_fastway_parcel | Parcel |
| easypost_fastway_satchel | Satchel |
| easypost_fedex_ground | FEDEX_GROUND |
| easypost_fedex_2_day | FEDEX_2_DAY |
| easypost_fedex_2_day_am | FEDEX_2_DAY_AM |
| easypost_fedex_express_saver | FEDEX_EXPRESS_SAVER |
| easypost_fedex_standard_overnight | STANDARD_OVERNIGHT |
| easypost_fedex_first_overnight | FIRST_OVERNIGHT |
| easypost_fedex_priority_overnight | PRIORITY_OVERNIGHT |
| easypost_fedex_international_economy | INTERNATIONAL_ECONOMY |
| easypost_fedex_international_first | INTERNATIONAL_FIRST |
| easypost_fedex_international_priority | INTERNATIONAL_PRIORITY |
| easypost_fedex_ground_home_delivery | GROUND_HOME_DELIVERY |
| easypost_fedex_crossborder_cbec | CBEC |
| easypost_fedex_crossborder_cbecl | CBECL |
| easypost_fedex_crossborder_cbecp | CBECP |
| easypost_fedex_sameday_city_economy_service | EconomyService |
| easypost_fedex_sameday_city_standard_service | StandardService |
| easypost_fedex_sameday_city_priority_service | PriorityService |
| easypost_fedex_sameday_city_last_mile | LastMile |
| easypost_fedex_smart_post | SMART_POST |
| easypost_globegistics_pmei | PMEI |
| easypost_globegistics_ecom_domestic | eComDomestic |
| easypost_globegistics_ecom_europe | eComEurope |
| easypost_globegistics_ecom_express | eComExpress |
| easypost_globegistics_ecom_extra | eComExtra |
| easypost_globegistics_ecom_ipa | eComIPA |
| easypost_globegistics_ecom_isal | eComISAL |
| easypost_globegistics_ecom_pmei_duty_paid | eComPMEIDutyPaid |
| easypost_globegistics_ecom_pmi_duty_paid | eComPMIDutyPaid |
| easypost_globegistics_ecom_packet | eComPacket |
| easypost_globegistics_ecom_packet_ddp | eComPacketDDP |
| easypost_globegistics_ecom_priority | eComPriority |
| easypost_globegistics_ecom_standard | eComStandard |
| easypost_globegistics_ecom_tracked_ddp | eComTrackedDDP |
| easypost_globegistics_ecom_tracked_ddu | eComTrackedDDU |
| easypost_gso_early_priority_overnight | EarlyPriorityOvernight |
| easypost_gso_priority_overnight | PriorityOvernight |
| easypost_gso_california_parcel_service | CaliforniaParcelService |
| easypost_gso_saturday_delivery_service | SaturdayDeliveryService |
| easypost_gso_early_saturday_service | EarlySaturdayService |
| easypost_hermes_domestic_delivery | DomesticDelivery |
| easypost_hermes_domestic_delivery_signed | DomesticDeliverySigned |
| easypost_hermes_international_delivery | InternationalDelivery |
| easypost_hermes_international_delivery_signed | InternationalDeliverySigned |
| easypost_interlink_air_classic_international_air | InterlinkAirClassicInternationalAir |
| easypost_interlink_air_express_international_air | InterlinkAirExpressInternationalAir |
| easypost_interlink_expresspak1_by10_30 | InterlinkExpresspak1By10:30 |
| easypost_interlink_expresspak1_by12 | InterlinkExpresspak1By12 |
| easypost_interlink_expresspak1_next_day | InterlinkExpresspak1NextDay |
| easypost_interlink_expresspak1_saturday | InterlinkExpresspak1Saturday |
| easypost_interlink_expresspak1_saturday_by10_30 | InterlinkExpresspak1SaturdayBy10:30 |
| easypost_interlink_expresspak1_saturday_by12 | InterlinkExpresspak1SaturdayBy12 |
| easypost_interlink_expresspak1_sunday | InterlinkExpresspak1Sunday |
| easypost_interlink_expresspak1_sunday_by12 | InterlinkExpresspak1SundayBy12 |
| easypost_interlink_expresspak5_by10 | InterlinkExpresspak5By10 |
| easypost_interlink_expresspak5_by10_30 | InterlinkExpresspak5By10:30 |
| easypost_interlink_expresspak5_by12 | InterlinkExpresspak5By12 |
| easypost_interlink_expresspak5_next_day | InterlinkExpresspak5NextDay |
| easypost_interlink_expresspak5_saturday | InterlinkExpresspak5Saturday |
| easypost_interlink_expresspak5_saturday_by10 | InterlinkExpresspak5SaturdayBy10 |
| easypost_interlink_expresspak5_saturday_by10_30 | InterlinkExpresspak5SaturdayBy10:30 |
| easypost_interlink_expresspak5_saturday_by12 | InterlinkExpresspak5SaturdayBy12 |
| easypost_interlink_expresspak5_sunday | InterlinkExpresspak5Sunday |
| easypost_interlink_expresspak5_sunday_by12 | InterlinkExpresspak5SundayBy12 |
| easypost_interlink_freight_by10 | InterlinkFreightBy10 |
| easypost_interlink_freight_by12 | InterlinkFreightBy12 |
| easypost_interlink_freight_next_day | InterlinkFreightNextDay |
| easypost_interlink_freight_saturday | InterlinkFreightSaturday |
| easypost_interlink_freight_saturday_by10 | InterlinkFreightSaturdayBy10 |
| easypost_interlink_freight_saturday_by12 | InterlinkFreightSaturdayBy12 |
| easypost_interlink_freight_sunday | InterlinkFreightSunday |
| easypost_interlink_freight_sunday_by12 | InterlinkFreightSundayBy12 |
| easypost_interlink_parcel_by10 | InterlinkParcelBy10 |
| easypost_interlink_parcel_by10_30 | InterlinkParcelBy10:30 |
| easypost_interlink_parcel_by12 | InterlinkParcelBy12 |
| easypost_interlink_parcel_dpd_europe_by_road | InterlinkParcelDpdEuropeByRoad |
| easypost_interlink_parcel_next_day | InterlinkParcelNextDay |
| easypost_interlink_parcel_return | InterlinkParcelReturn |
| easypost_interlink_parcel_return_to_shop | InterlinkParcelReturnToShop |
| easypost_interlink_parcel_saturday | InterlinkParcelSaturday |
| easypost_interlink_parcel_saturday_by10 | InterlinkParcelSaturdayBy10 |
| easypost_interlink_parcel_saturday_by10_30 | InterlinkParcelSaturdayBy10:30 |
| easypost_interlink_parcel_saturday_by12 | InterlinkParcelSaturdayBy12 |
| easypost_interlink_parcel_ship_to_shop | InterlinkParcelShipToShop |
| easypost_interlink_parcel_sunday | InterlinkParcelSunday |
| easypost_interlink_parcel_sunday_by12 | InterlinkParcelSundayBy12 |
| easypost_interlink_parcel_two_day | InterlinkParcelTwoDay |
| easypost_interlink_pickup_parcel_dpd_europe_by_road | InterlinkPickupParcelDpdEuropeByRoad |
| easypost_lasership_weekend | Weekend |
| easypost_loomis_ground | LoomisGround |
| easypost_loomis_express1800 | LoomisExpress1800 |
| easypost_loomis_express1200 | LoomisExpress1200 |
| easypost_loomis_express900 | LoomisExpress900 |
| easypost_lso_ground_early | GroundEarly |
| easypost_lso_ground_basic | GroundBasic |
| easypost_lso_priority_basic | PriorityBasic |
| easypost_lso_priority_early | PriorityEarly |
| easypost_lso_priority_saturday | PrioritySaturday |
| easypost_lso_priority2nd_day | Priority2ndDay |
| easypost_newgistics_parcel_select | ParcelSelect |
| easypost_newgistics_parcel_select_lightweight | ParcelSelectLightweight |
| easypost_newgistics_express | Express |
| easypost_newgistics_first_class_mail | FirstClassMail |
| easypost_newgistics_priority_mail | PriorityMail |
| easypost_newgistics_bound_printed_matter | BoundPrintedMatter |
| easypost_ontrac_sunrise | Sunrise |
| easypost_ontrac_gold | Gold |
| easypost_ontrac_on_trac_ground | OnTracGround |
| easypost_ontrac_palletized_freight | PalletizedFreight |
| easypost_osm_first | First |
| easypost_osm_expedited | Expedited |
| easypost_osm_bpm | BPM |
| easypost_osm_media_mail | MediaMail |
| easypost_osm_marketing_parcel | MarketingParcel |
| easypost_osm_marketing_parcel_tracked | MarketingParcelTracked |
| easypost_parcll_economy_west | Economy West |
| easypost_parcll_economy_east | Economy East |
| easypost_parcll_economy_central | Economy Central |
| easypost_parcll_economy_northeast | Economy Northeast |
| easypost_parcll_economy_south | Economy South |
| easypost_parcll_expedited_west | Expedited West |
| easypost_parcll_expedited_northeast | Expedited Northeast |
| easypost_parcll_regional_west | Regional West |
| easypost_parcll_regional_east | Regional East |
| easypost_parcll_regional_central | Regional Central |
| easypost_parcll_regional_northeast | Regional Northeast |
| easypost_parcll_regional_south | Regional South |
| easypost_parcll_us_to_canada_economy_west | US to Canada Economy West |
| easypost_parcll_us_to_canada_economy_central | US to Canada Economy Central |
| easypost_parcll_us_to_canada_economy_northeast | US to Canada Economy Northeast |
| easypost_parcll_us_to_europe_economy_west | US to Europe Economy West |
| easypost_parcll_us_to_europe_economy_northeast | US to Europe Economy Northeast |
| easypost_purolator_express | PurolatorExpress |
| easypost_purolator_express12_pm | PurolatorExpress12PM |
| easypost_purolator_express_pack12_pm | PurolatorExpressPack12PM |
| easypost_purolator_express_box12_pm | PurolatorExpressBox12PM |
| easypost_purolator_express_envelope12_pm | PurolatorExpressEnvelope12PM |
| easypost_purolator_express1030_am | PurolatorExpress1030AM |
| easypost_purolator_express9_am | PurolatorExpress9AM |
| easypost_purolator_express_box | PurolatorExpressBox |
| easypost_purolator_express_box1030_am | PurolatorExpressBox1030AM |
| easypost_purolator_express_box9_am | PurolatorExpressBox9AM |
| easypost_purolator_express_box_evening | PurolatorExpressBoxEvening |
| easypost_purolator_express_box_international | PurolatorExpressBoxInternational |
| easypost_purolator_express_box_international1030_am | PurolatorExpressBoxInternational1030AM |
| easypost_purolator_express_box_international1200 | PurolatorExpressBoxInternational1200 |
| easypost_purolator_express_box_international9_am | PurolatorExpressBoxInternational9AM |
| easypost_purolator_express_box_us | PurolatorExpressBoxUS |
| easypost_purolator_express_box_us1030_am | PurolatorExpressBoxUS1030AM |
| easypost_purolator_express_box_us1200 | PurolatorExpressBoxUS1200 |
| easypost_purolator_express_box_us9_am | PurolatorExpressBoxUS9AM |
| easypost_purolator_express_envelope | PurolatorExpressEnvelope |
| easypost_purolator_express_envelope1030_am | PurolatorExpressEnvelope1030AM |
| easypost_purolator_express_envelope9_am | PurolatorExpressEnvelope9AM |
| easypost_purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening |
| easypost_purolator_express_envelope_international | PurolatorExpressEnvelopeInternational |
| easypost_purolator_express_envelope_international1030_am | PurolatorExpressEnvelopeInternational1030AM |
| easypost_purolator_express_envelope_international1200 | PurolatorExpressEnvelopeInternational1200 |
| easypost_purolator_express_envelope_international9_am | PurolatorExpressEnvelopeInternational9AM |
| easypost_purolator_express_envelope_us | PurolatorExpressEnvelopeUS |
| easypost_purolator_express_envelope_us1030_am | PurolatorExpressEnvelopeUS1030AM |
| easypost_purolator_express_envelope_us1200 | PurolatorExpressEnvelopeUS1200 |
| easypost_purolator_express_envelope_us9_am | PurolatorExpressEnvelopeUS9AM |
| easypost_purolator_express_evening | PurolatorExpressEvening |
| easypost_purolator_express_international | PurolatorExpressInternational |
| easypost_purolator_express_international1030_am | PurolatorExpressInternational1030AM |
| easypost_purolator_express_international1200 | PurolatorExpressInternational1200 |
| easypost_purolator_express_international9_am | PurolatorExpressInternational9AM |
| easypost_purolator_express_pack | PurolatorExpressPack |
| easypost_purolator_express_pack1030_am | PurolatorExpressPack1030AM |
| easypost_purolator_express_pack9_am | PurolatorExpressPack9AM |
| easypost_purolator_express_pack_evening | PurolatorExpressPackEvening |
| easypost_purolator_express_pack_international | PurolatorExpressPackInternational |
| easypost_purolator_express_pack_international1030_am | PurolatorExpressPackInternational1030AM |
| easypost_purolator_express_pack_international1200 | PurolatorExpressPackInternational1200 |
| easypost_purolator_express_pack_international9_am | PurolatorExpressPackInternational9AM |
| easypost_purolator_express_pack_us | PurolatorExpressPackUS |
| easypost_purolator_express_pack_us1030_am | PurolatorExpressPackUS1030AM |
| easypost_purolator_express_pack_us1200 | PurolatorExpressPackUS1200 |
| easypost_purolator_express_pack_us9_am | PurolatorExpressPackUS9AM |
| easypost_purolator_express_us | PurolatorExpressUS |
| easypost_purolator_express_us1030_am | PurolatorExpressUS1030AM |
| easypost_purolator_express_us1200 | PurolatorExpressUS1200 |
| easypost_purolator_express_us9_am | PurolatorExpressUS9AM |
| easypost_purolator_ground | PurolatorGround |
| easypost_purolator_ground1030_am | PurolatorGround1030AM |
| easypost_purolator_ground9_am | PurolatorGround9AM |
| easypost_purolator_ground_distribution | PurolatorGroundDistribution |
| easypost_purolator_ground_evening | PurolatorGroundEvening |
| easypost_purolator_ground_regional | PurolatorGroundRegional |
| easypost_purolator_ground_us | PurolatorGroundUS |
| easypost_royalmail_international_signed | InternationalSigned |
| easypost_royalmail_international_tracked | InternationalTracked |
| easypost_royalmail_international_tracked_and_signed | InternationalTrackedAndSigned |
| easypost_royalmail_1st_class | 1stClass |
| easypost_royalmail_1st_class_signed_for | 1stClassSignedFor |
| easypost_royalmail_2nd_class | 2ndClass |
| easypost_royalmail_2nd_class_signed_for | 2ndClassSignedFor |
| easypost_royalmail_royal_mail24 | RoyalMail24 |
| easypost_royalmail_royal_mail24_signed_for | RoyalMail24SignedFor |
| easypost_royalmail_royal_mail48 | RoyalMail48 |
| easypost_royalmail_royal_mail48_signed_for | RoyalMail48SignedFor |
| easypost_royalmail_special_delivery_guaranteed1pm | SpecialDeliveryGuaranteed1pm |
| easypost_royalmail_special_delivery_guaranteed9am | SpecialDeliveryGuaranteed9am |
| easypost_royalmail_standard_letter1st_class | StandardLetter1stClass |
| easypost_royalmail_standard_letter1st_class_signed_for | StandardLetter1stClassSignedFor |
| easypost_royalmail_standard_letter2nd_class | StandardLetter2ndClass |
| easypost_royalmail_standard_letter2nd_class_signed_for | StandardLetter2ndClassSignedFor |
| easypost_royalmail_tracked24 | Tracked24 |
| easypost_royalmail_tracked24_high_volume | Tracked24HighVolume |
| easypost_royalmail_tracked24_high_volume_signature | Tracked24HighVolumeSignature |
| easypost_royalmail_tracked24_signature | Tracked24Signature |
| easypost_royalmail_tracked48 | Tracked48 |
| easypost_royalmail_tracked48_high_volume | Tracked48HighVolume |
| easypost_royalmail_tracked48_high_volume_signature | Tracked48HighVolumeSignature |
| easypost_royalmail_tracked48_signature | Tracked48Signature |
| easypost_seko_ecommerce_standard_tracked | eCommerce Standard Tracked |
| easypost_seko_ecommerce_express_tracked | eCommerce Express Tracked |
| easypost_seko_domestic_express | Domestic Express |
| easypost_seko_domestic_standard | Domestic Standard |
| easypost_sendle_easy | Easy |
| easypost_sendle_pro | Pro |
| easypost_sendle_plus | Plus |
| easypost_sfexpress_international_standard_express_doc | International Standard Express - Doc |
| easypost_sfexpress_international_standard_express_parcel | International Standard Express - Parcel |
| easypost_sfexpress_international_economy_express_pilot | International Economy Express - Pilot |
| easypost_sfexpress_international_economy_express_doc | International Economy Express - Doc |
| easypost_speedee_delivery | SpeeDeeDelivery |
| easypost_startrack_express | StartrackExpress |
| easypost_startrack_premium | StartrackPremium |
| easypost_startrack_fixed_price_premium | StartrackFixedPricePremium |
| easypost_tforce_same_day_white_glove | SameDayWhiteGlove |
| easypost_tforce_next_day_white_glove | NextDayWhiteGlove |
| easypost_uds_delivery_service | DeliveryService |
| easypost_ups_standard | UPSStandard |
| easypost_ups_saver | UPSSaver |
| easypost_ups_express_plus | ExpressPlus |
| easypost_ups_next_day_air | NextDayAir |
| easypost_ups_next_day_air_saver | NextDayAirSaver |
| easypost_ups_next_day_air_early_am | NextDayAirEarlyAM |
| easypost_ups_2nd_day_air | 2ndDayAir |
| easypost_ups_2nd_day_air_am | 2ndDayAirAM |
| easypost_ups_3_day_select | 3DaySelect |
| easypost_ups_mail_expedited_mail_innovations | ExpeditedMailInnovations |
| easypost_ups_mail_priority_mail_innovations | PriorityMailInnovations |
| easypost_ups_mail_economy_mail_innovations | EconomyMailInnovations |
| easypost_usps_library_mail | LibraryMail |
| easypost_usps_first_class_mail_international | FirstClassMailInternational |
| easypost_usps_first_class_package_international_service | FirstClassPackageInternationalService |
| easypost_usps_priority_mail_international | PriorityMailInternational |
| easypost_usps_express_mail_international | ExpressMailInternational |
| easypost_veho_next_day | nextDay |
| easypost_veho_same_day | sameDay |
### eShipper
| Code | Service Name |
| ------------ | ------------ |
| eshipper_all | 0 |
| eshipper_fedex_priority | 1 |
| eshipper_fedex_first_overnight | 2 |
| eshipper_fedex_ground | 3 |
| eshipper_fedex_standard_overnight | 28 |
| eshipper_fedex_2nd_day | 29 |
| eshipper_fedex_express_saver | 30 |
| eshipper_fedex_international_economy | 35 |
| eshipper_purolator_air | 4 |
| eshipper_purolator_air_9_am | 5 |
| eshipper_purolator_air_10_30 | 6 |
| eshipper_purolator_letter | 7 |
| eshipper_purolator_letter_9_am | 8 |
| eshipper_purolator_letter_10_30 | 9 |
| eshipper_purolator_pak | 10 |
| eshipper_purolator_pak_9_am | 11 |
| eshipper_purolator_pak_10_30 | 12 |
| eshipper_purolator_ground | 13 |
| eshipper_purolator_ground_9_am | 19 |
| eshipper_purolator_ground_10_30 | 20 |
| eshipper_canada_worldwide_same_day | 14 |
| eshipper_canada_worldwide_next_flight_out | 15 |
| eshipper_canada_worldwide_air_freight | 16 |
| eshipper_canada_worldwide_ltl | 17 |
| eshipper_dhl_express_worldwide | 101 |
| eshipper_dhl_express_12_pm | 103 |
| eshipper_dhl_express_10_30_am | 102 |
| eshipper_dhl_esi_export | 104 |
| eshipper_dhl_international_express | 106 |
| eshipper_ups_express_next_day_air | 600 |
| eshipper_ups_expedited_second_day_air | 601 |
| eshipper_ups_worldwide_express | 602 |
| eshipper_ups_worldwide_expedited | 603 |
| eshipper_ups_standard_ground | 604 |
| eshipper_ups_express_early_am_next_day_air_early_am | 605 |
| eshipper_ups_three_day_select | 606 |
| eshipper_ups_saver | 607 |
| eshipper_ups_ground | 608 |
| eshipper_ups_next_day_saver | 609 |
| eshipper_ups_worldwide_express_plus | 610 |
| eshipper_ups_second_day_air_am | 611 |
| eshipper_canada_post_priority | 500 |
| eshipper_canada_post_xpresspost | 501 |
| eshipper_canada_post_expedited | 502 |
| eshipper_canada_post_regular | 503 |
| eshipper_canada_post_xpresspost_usa | 504 |
| eshipper_canada_post_xpresspost_intl | 505 |
| eshipper_canada_post_air_parcel_intl | 506 |
| eshipper_canada_post_surface_parcel_intl | 507 |
| eshipper_canada_post_expedited_parcel_usa | 508 |
| eshipper_tst_ltl | 1100 |
| eshipper_ltl_chicago_suburban_express | 1500 |
| eshipper_ltl_fedex_freight_east | 1501 |
| eshipper_ltl_fedex_freight_west | 1502 |
| eshipper_ltl_mid_states_express | 1503 |
| eshipper_ltl_new_england_motor_freight | 1504 |
| eshipper_ltl_new_penn | 1505 |
| eshipper_ltl_oak_harbor | 1506 |
| eshipper_ltl_pitt_ohio | 1507 |
| eshipper_ltl_r_l_carriers | 1508 |
| eshipper_ltl_saia | 1509 |
| eshipper_ltl_usf_reddaway | 1510 |
| eshipper_ltl_vitran_express | 1511 |
| eshipper_ltl_wilson_trucking | 1512 |
| eshipper_ltl_yellow_transportation | 1513 |
| eshipper_ltl_roadway | 1514 |
| eshipper_ltl_fedex_national | 1515 |
| eshipper_wilson_trucking_tfc | 1800 |
| eshipper_aaa_cooper_transportation | 1801 |
| eshipper_roadrunner_dawes | 1802 |
| eshipper_new_england_motor_freight | 1803 |
| eshipper_new_penn_motor_express | 1804 |
| eshipper_dayton_freight | 1805 |
| eshipper_southeastern_freightway | 1806 |
| eshipper_saia_inc | 1807 |
| eshipper_conway | 1808 |
| eshipper_roadway | 1809 |
| eshipper_usf_reddaway | 1810 |
| eshipper_usf_holland | 1811 |
| eshipper_dependable_highway_express | 1812 |
| eshipper_day_and_ross | 1813 |
| eshipper_day_and_ross_r_and_l | 1814 |
| eshipper_ups | 1815 |
| eshipper_aaa_cooper | 1816 |
| eshipper_ama_transportation | 1817 |
| eshipper_averitt_express | 1818 |
| eshipper_central_freight | 1819 |
| eshipper_conway_us | 1820 |
| eshipper_dayton | 1821 |
| eshipper_drug_transport | 1822 |
| eshipper_estes | 1823 |
| eshipper_land_air_express | 1824 |
| eshipper_fedex_west | 1825 |
| eshipper_fedex_national | 1826 |
| eshipper_usf_holland_us | 1827 |
| eshipper_lakeville_m_express | 1828 |
| eshipper_milan_express | 1829 |
| eshipper_nebraska_transport | 1830 |
| eshipper_new_england | 1831 |
| eshipper_new_penn | 1832 |
| eshipper_a_duie_pyle | 1833 |
| eshipper_roadway_us | 1834 |
| eshipper_usf_reddaway_us | 1835 |
| eshipper_rhody_transportation | 1836 |
| eshipper_saia_motor_freight | 1837 |
| eshipper_southeastern_frgt | 1838 |
| eshipper_pitt_ohio | 1839 |
| eshipper_ward | 1840 |
| eshipper_wilson | 1841 |
| eshipper_chi_cargo | 1842 |
| eshipper_tax_air | 1843 |
| eshipper_fedex_east | 1844 |
| eshipper_central_transport | 1845 |
| eshipper_roadrunner | 1846 |
| eshipper_r_and_l_carriers | 1847 |
| eshipper_estes_us | 1848 |
| eshipper_yrc_roadway | 1849 |
| eshipper_central_transport_us | 1850 |
| eshipper_absolute_transportation_services | 1851 |
| eshipper_blue_sky_express | 1852 |
| eshipper_galasso_trucking | 1853 |
| eshipper_griley_air_freight | 1854 |
| eshipper_jet_transportation | 1855 |
| eshipper_metro_transportation_logistics | 1856 |
| eshipper_oak_harbor | 1857 |
| eshipper_stream_links_express | 1858 |
| eshipper_tiffany_trucking | 1859 |
| eshipper_ups_freight | 1860 |
| eshipper_roadrunner_us | 1861 |
| eshipper_global_mail_parcel_priority | 3500 |
| eshipper_global_mail_parcel_standard | 3501 |
| eshipper_global_mail_packet_plus_priority | 3502 |
| eshipper_global_mail_packet_priority | 3503 |
| eshipper_global_mail_packet_standard | 3504 |
| eshipper_global_mail_business_priority | 3505 |
| eshipper_global_mail_business_standard | 3506 |
| eshipper_global_mail_parcel_direct_priority | 3507 |
| eshipper_global_mail_parcel_direct_standard | 3508 |
| eshipper_canpar_ground | 4500 |
| eshipper_canpar_select_parcel | 4504 |
| eshipper_canpar_express_parcel | 4507 |
| eshipper_fleet_optics_ground | 5601 |
### FedEx
| Code | Service Name |
| ------------ | ------------ |
| fedex_europe_first_international_priority | EUROPE_FIRST_INTERNATIONAL_PRIORITY |
| fedex_1_day_freight | FEDEX_1_DAY_FREIGHT |
| fedex_2_day | FEDEX_2_DAY |
| fedex_2_day_am | FEDEX_2_DAY_AM |
| fedex_2_day_freight | FEDEX_2_DAY_FREIGHT |
| fedex_3_day_freight | FEDEX_3_DAY_FREIGHT |
| fedex_cargo_airport_to_airport | FEDEX_CARGO_AIRPORT_TO_AIRPORT |
| fedex_cargo_freight_forwarding | FEDEX_CARGO_FREIGHT_FORWARDING |
| fedex_cargo_international_express_freight | FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT |
| fedex_cargo_international_premium | FEDEX_CARGO_INTERNATIONAL_PREMIUM |
| fedex_cargo_mail | FEDEX_CARGO_MAIL |
| fedex_cargo_registered_mail | FEDEX_CARGO_REGISTERED_MAIL |
| fedex_cargo_surface_mail | FEDEX_CARGO_SURFACE_MAIL |
| fedex_custom_critical_air_expedite | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE |
| fedex_custom_critical_air_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE |
| fedex_custom_critical_air_expedite_network | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK |
| fedex_custom_critical_charter_air | FEDEX_CUSTOM_CRITICAL_CHARTER_AIR |
| fedex_custom_critical_point_to_point | FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT |
| fedex_custom_critical_surface_expedite | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE |
| fedex_custom_critical_surface_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE |
| fedex_custom_critical_temp_assure_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR |
| fedex_custom_critical_temp_assure_validated_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR |
| fedex_custom_critical_white_glove_services | FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES |
| fedex_distance_deferred | FEDEX_DISTANCE_DEFERRED |
| fedex_express_saver | FEDEX_EXPRESS_SAVER |
| fedex_first_freight | FEDEX_FIRST_FREIGHT |
| fedex_freight_economy | FEDEX_FREIGHT_ECONOMY |
| fedex_freight_priority | FEDEX_FREIGHT_PRIORITY |
| fedex_ground | FEDEX_GROUND |
| fedex_international_priority_plus | FEDEX_INTERNATIONAL_PRIORITY_PLUS |
| fedex_next_day_afternoon | FEDEX_NEXT_DAY_AFTERNOON |
| fedex_next_day_early_morning | FEDEX_NEXT_DAY_EARLY_MORNING |
| fedex_next_day_end_of_day | FEDEX_NEXT_DAY_END_OF_DAY |
| fedex_next_day_freight | FEDEX_NEXT_DAY_FREIGHT |
| fedex_next_day_mid_morning | FEDEX_NEXT_DAY_MID_MORNING |
| fedex_first_overnight | FIRST_OVERNIGHT |
| fedex_ground_home_delivery | GROUND_HOME_DELIVERY |
| fedex_international_distribution_freight | INTERNATIONAL_DISTRIBUTION_FREIGHT |
| fedex_international_economy | INTERNATIONAL_ECONOMY |
| fedex_international_economy_distribution | INTERNATIONAL_ECONOMY_DISTRIBUTION |
| fedex_international_economy_freight | INTERNATIONAL_ECONOMY_FREIGHT |
| fedex_international_first | INTERNATIONAL_FIRST |
| fedex_international_ground | INTERNATIONAL_GROUND |
| fedex_international_priority | INTERNATIONAL_PRIORITY |
| fedex_international_priority_distribution | INTERNATIONAL_PRIORITY_DISTRIBUTION |
| fedex_international_priority_express | INTERNATIONAL_PRIORITY_EXPRESS |
| fedex_international_priority_freight | INTERNATIONAL_PRIORITY_FREIGHT |
| fedex_priority_overnight | PRIORITY_OVERNIGHT |
| fedex_same_day | SAME_DAY |
| fedex_same_day_city | SAME_DAY_CITY |
| fedex_same_day_metro_afternoon | SAME_DAY_METRO_AFTERNOON |
| fedex_same_day_metro_morning | SAME_DAY_METRO_MORNING |
| fedex_same_day_metro_rush | SAME_DAY_METRO_RUSH |
| fedex_smart_post | SMART_POST |
| fedex_standard_overnight | STANDARD_OVERNIGHT |
| fedex_transborder_distribution_consolidation | TRANSBORDER_DISTRIBUTION_CONSOLIDATION |
### Freightcom
| Code | Service Name |
| ------------ | ------------ |
| freightcom_all | 0 |
| freightcom_usf_holland | 1911 |
| freightcom_central_transport | 2029 |
| freightcom_estes | 2107 |
| freightcom_canpar_ground | 3400 |
| freightcom_canpar_select | 3404 |
| freightcom_canpar_overnight | 3407 |
| freightcom_dicom_ground | 3700 |
| freightcom_purolator_ground | 4000 |
| freightcom_purolator_express | 4003 |
| freightcom_purolator_express_9_am | 4004 |
| freightcom_purolator_express_10_30_am | 4005 |
| freightcom_purolator_ground_us | 4016 |
| freightcom_purolator_express_us | 4015 |
| freightcom_purolator_express_us_9_am | 4013 |
| freightcom_purolator_express_us_10_30_am | 4014 |
| freightcom_fedex_express_saver | 4100 |
| freightcom_fedex_ground | 4101 |
| freightcom_fedex_2day | 4102 |
| freightcom_fedex_priority_overnight | 4104 |
| freightcom_fedex_standard_overnight | 4105 |
| freightcom_fedex_first_overnight | 4106 |
| freightcom_fedex_international_priority | 4108 |
| freightcom_fedex_international_economy | 4109 |
| freightcom_ups_standard | 4600 |
| freightcom_ups_expedited | 4601 |
| freightcom_ups_express_saver | 4602 |
| freightcom_ups_express | 4603 |
| freightcom_ups_express_early | 4604 |
| freightcom_ups_3day_select | 4605 |
| freightcom_ups_worldwide_expedited | 4606 |
| freightcom_ups_worldwide_express | 4607 |
| freightcom_ups_worldwide_express_plus | 4608 |
| freightcom_ups_worldwide_express_saver | 4609 |
| freightcom_dhl_express_easy | 5202 |
| freightcom_dhl_express_10_30 | 5208 |
| freightcom_dhl_express_worldwide | 5211 |
| freightcom_dhl_express_12_00 | 5215 |
| freightcom_dhl_economy_select | 5216 |
| freightcom_dhl_ecommerce_am_service | 5706 |
| freightcom_dhl_ecommerce_ground_service | 5707 |
| freightcom_canadapost_regular_parcel | 6301 |
| freightcom_canadapost_expedited_parcel | 6300 |
| freightcom_canadapost_xpresspost | 6303 |
| freightcom_canadapost_priority | 6302 |
### Purolator
| Code | Service Name |
| ------------ | ------------ |
| purolator_express_9_am | PurolatorExpress9AM |
| purolator_express_us | PurolatorExpressU.S. |
| purolator_express_10_30_am | PurolatorExpress10:30AM |
| purolator_express_us_9_am | PurolatorExpressU.S.9AM |
| purolator_express_12_pm | PurolatorExpress12PM |
| purolator_express_us_10_30_am | PurolatorExpressU.S.10:30AM |
| purolator_express | PurolatorExpress |
| purolator_express_us_12_00 | PurolatorExpressU.S.12:00 |
| purolator_express_evening | PurolatorExpressEvening |
| purolator_express_envelope_us | PurolatorExpressEnvelopeU.S. |
| purolator_express_envelope_9_am | PurolatorExpressEnvelope9AM |
| purolator_express_us_envelope_9_am | PurolatorExpressU.S.Envelope9AM |
| purolator_express_envelope_10_30_am | PurolatorExpressEnvelope10:30AM |
| purolator_express_us_envelope_10_30_am | PurolatorExpressU.S.Envelope10:30AM |
| purolator_express_envelope_12_pm | PurolatorExpressEnvelope12PM |
| purolator_express_us_envelope_12_00 | PurolatorExpressU.S.Envelope12:00 |
| purolator_express_envelope | PurolatorExpressEnvelope |
| purolator_express_pack_us | PurolatorExpressPackU.S. |
| purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening |
| purolator_express_us_pack_9_am | PurolatorExpressU.S.Pack9AM |
| purolator_express_pack_9_am | PurolatorExpressPack9AM |
| purolator_express_us_pack_10_30_am | PurolatorExpressU.S.Pack10:30AM |
| purolator_express_pack10_30_am | PurolatorExpressPack10:30AM |
| purolator_express_us_pack_12_00 | PurolatorExpressU.S.Pack12:00 |
| purolator_express_pack_12_pm | PurolatorExpressPack12PM |
| purolator_express_box_us | PurolatorExpressBoxU.S. |
| purolator_express_pack | PurolatorExpressPack |
| purolator_express_us_box_9_am | PurolatorExpressU.S.Box9AM |
| purolator_express_pack_evening | PurolatorExpressPackEvening |
| purolator_express_us_box_10_30_am | PurolatorExpressU.S.Box10:30AM |
| purolator_express_box_9_am | PurolatorExpressBox9AM |
| purolator_express_us_box_12_00 | PurolatorExpressU.S.Box12:00 |
| purolator_express_box_10_30_am | PurolatorExpressBox10:30AM |
| purolator_ground_us | PurolatorGroundU.S. |
| purolator_express_box_12_pm | PurolatorExpressBox12PM |
| purolator_express_international | PurolatorExpressInternational |
| purolator_express_box | PurolatorExpressBox |
| purolator_express_international_9_am | PurolatorExpressInternational9AM |
| purolator_express_box_evening | PurolatorExpressBoxEvening |
| purolator_express_international_10_30_am | PurolatorExpressInternational10:30AM |
| purolator_ground | PurolatorGround |
| purolator_express_international_12_00 | PurolatorExpressInternational12:00 |
| purolator_ground_9_am | PurolatorGround9AM |
| purolator_express_envelope_international | PurolatorExpressEnvelopeInternational |
| purolator_ground_10_30_am | PurolatorGround10:30AM |
| purolator_express_international_envelope_9_am | PurolatorExpressInternationalEnvelope9AM |
| purolator_ground_evening | PurolatorGroundEvening |
| purolator_express_international_envelope_10_30_am | PurolatorExpressInternationalEnvelope10:30AM |
| purolator_quick_ship | PurolatorQuickShip |
| purolator_express_international_envelope_12_00 | PurolatorExpressInternationalEnvelope12:00 |
| purolator_quick_ship_envelope | PurolatorQuickShipEnvelope |
| purolator_express_pack_international | PurolatorExpressPackInternational |
| purolator_quick_ship_pack | PurolatorQuickShipPack |
| purolator_express_international_pack_9_am | PurolatorExpressInternationalPack9AM |
| purolator_quick_ship_box | PurolatorQuickShipBox |
| purolator_express_international_pack_10_30_am | PurolatorExpressInternationalPack10:30AM |
| purolator_express_international_pack_12_00 | PurolatorExpressInternationalPack12:00 |
| purolator_express_box_international | PurolatorExpressBoxInternational |
| purolator_express_international_box_9_am | PurolatorExpressInternationalBox9AM |
| purolator_express_international_box_10_30_am | PurolatorExpressInternationalBox10:30AM |
| purolator_express_international_box_12_00 | PurolatorExpressInternationalBox12:00 |
### TNT
| Code | Service Name |
| ------------ | ------------ |
| tnt_special_express | 1N |
| tnt_9_00_express | 09N |
| tnt_10_00_express | 10N |
| tnt_12_00_express | 12N |
| tnt_express | EX |
| tnt_economy_express | 48N |
| tnt_global_express | 15N |
### UPS
| Code | Service Name |
| ------------ | ------------ |
| ups_standard | UPS Standard |
| ups_worldwide_express | UPS Worldwide Express |
| ups_worldwide_expedited | UPS Worldwide Expedited |
| ups_worldwide_express_plus | UPS Worldwide Express Plus |
| ups_worldwide_saver | UPS Worldwide Saver |
| ups_2nd_day_air | UPS 2nd Day Air |
| ups_2nd_day_air_am | UPS 2nd Day Air A.M. |
| ups_3_day_select | UPS 3 Day Select |
| ups_ground | UPS Ground |
| ups_next_day_air | UPS Next Day Air |
| ups_next_day_air_early | UPS Next Day Air Early |
| ups_next_day_air_saver | UPS Next Day Air Saver |
| ups_expedited_ca | UPS Expedited CA |
| ups_express_saver_ca | UPS Express Saver CA |
| ups_3_day_select_ca_us | UPS 3 Day Select CA US |
| ups_access_point_economy_ca | UPS Access Point Economy CA |
| ups_express_ca | UPS Express CA |
| ups_express_early_ca | UPS Express Early CA |
| ups_express_saver_intl_ca | UPS Express Saver Intl CA |
| ups_standard_ca | UPS Standard CA |
| ups_worldwide_expedited_ca | UPS Worldwide Expedited CA |
| ups_worldwide_express_ca | UPS Worldwide Express CA |
| ups_worldwide_express_plus_ca | UPS Worldwide Express Plus CA |
| ups_express_early_ca_us | UPS Express Early CA US |
| ups_access_point_economy_eu | UPS Access Point Economy EU |
| ups_expedited_eu | UPS Expedited EU |
| ups_express_eu | UPS Express EU |
| ups_standard_eu | UPS Standard EU |
| ups_worldwide_express_plus_eu | UPS Worldwide Express Plus EU |
| ups_worldwide_saver_eu | UPS Worldwide Saver EU |
| ups_access_point_economy_mx | UPS Access Point Economy MX |
| ups_expedited_mx | UPS Expedited MX |
| ups_express_mx | UPS Express MX |
| ups_standard_mx | UPS Standard MX |
| ups_worldwide_express_plus_mx | UPS Worldwide Express Plus MX |
| ups_worldwide_saver_mx | UPS Worldwide Saver MX |
| ups_access_point_economy_pl | UPS Access Point Economy PL |
| ups_today_dedicated_courrier_pl | UPS Today Dedicated Courrier PL |
| ups_today_express_pl | UPS Today Express PL |
| ups_today_express_saver_pl | UPS Today Express Saver PL |
| ups_today_standard_pl | UPS Today Standard PL |
| ups_expedited_pl | UPS Expedited PL |
| ups_express_pl | UPS Express PL |
| ups_express_plus_pl | UPS Express Plus PL |
| ups_express_saver_pl | UPS Express Saver PL |
| ups_standard_pl | UPS Standard PL |
| ups_2nd_day_air_pr | UPS 2nd Day Air PR |
| ups_ground_pr | UPS Ground PR |
| ups_next_day_air_pr | UPS Next Day Air PR |
| ups_next_day_air_early_pr | UPS Next Day Air Early PR |
| ups_worldwide_expedited_pr | UPS Worldwide Expedited PR |
| ups_worldwide_express_pr | UPS Worldwide Express PR |
| ups_worldwide_express_plus_pr | UPS Worldwide Express Plus PR |
| ups_worldwide_saver_pr | UPS Worldwide Saver PR |
| ups_express_12_00_de | UPS Express 12:00 DE |
| ups_worldwide_express_freight | UPS Worldwide Express Freight |
| ups_worldwide_express_freight_midday | UPS Worldwide Express Freight Midday |
| ups_worldwide_economy_ddu | UPS Worldwide Economy DDU |
| ups_worldwide_economy_ddp | UPS Worldwide Economy DDP |
### USPS
| Code | Service Name |
| ------------ | ------------ |
| usps_first_class | First Class |
| usps_first_class_commercial | First Class Commercial |
| usps_first_class_hfp_commercial | First Class HFPCommercial |
| usps_priority | Priority |
| usps_priority_commercial | Priority Commercial |
| usps_priority_cpp | Priority Cpp |
| usps_priority_hfp_commercial | Priority HFP Commercial |
| usps_priority_hfp_cpp | Priority HFP CPP |
| usps_priority_mail_express | Priority Mail Express |
| usps_priority_mail_express_commercial | Priority Mail Express Commercial |
| usps_priority_mail_express_cpp | Priority Mail Express CPP |
| usps_priority_mail_express_sh | Priority Mail Express Sh |
| usps_priority_mail_express_sh_commercial | Priority Mail Express ShCommercial |
| usps_priority_mail_express_hfp | Priority Mail Express HFP |
| usps_priority_mail_express_hfp_commercial | Priority Mail Express HFP Commercial |
| usps_priority_mail_express_hfp_cpp | Priority Mail Express HFP CPP |
| usps_priority_mail_cubic | Priority Mail Cubic |
| usps_retail_ground | Retail Ground |
| usps_media | Media |
| usps_library | Library |
| usps_all | All |
| usps_online | Online |
| usps_plus | Plus |
| usps_bpm | BPM |
### USPS International
| Code | Service Name |
| ------------ | ------------ |
| usps_first_class | First Class |
| usps_first_class_commercial | First Class Commercial |
| usps_first_class_hfp_commercial | First Class HFPCommercial |
| usps_priority | Priority |
| usps_priority_commercial | Priority Commercial |
| usps_priority_cpp | Priority Cpp |
| usps_priority_hfp_commercial | Priority HFP Commercial |
| usps_priority_hfp_cpp | Priority HFP CPP |
| usps_priority_mail_express | Priority Mail Express |
| usps_priority_mail_express_commercial | Priority Mail Express Commercial |
| usps_priority_mail_express_cpp | Priority Mail Express CPP |
| usps_priority_mail_express_sh | Priority Mail Express Sh |
| usps_priority_mail_express_sh_commercial | Priority Mail Express ShCommercial |
| usps_priority_mail_express_hfp | Priority Mail Express HFP |
| usps_priority_mail_express_hfp_commercial | Priority Mail Express HFP Commercial |
| usps_priority_mail_express_hfp_cpp | Priority Mail Express HFP CPP |
| usps_priority_mail_cubic | Priority Mail Cubic |
| usps_retail_ground | Retail Ground |
| usps_media | Media |
| usps_library | Library |
| usps_all | All |
| usps_online | Online |
| usps_plus | Plus |
| usps_bpm | BPM |
### DHL Express
| Code | Service Name |
| ------------ | ------------ |
| dhl_logistics_services | 0 |
| dhl_domestic_express_12_00_doc | 1 |
| dhl_b2c_doc | 2 |
| dhl_b2c_nondoc | 3 |
| dhl_jetline | 4 |
| dhl_sprintline | 5 |
| dhl_express_easy_doc | 7 |
| dhl_express_easy_nondoc | 8 |
| dhl_europack_doc | 9 |
| dhl_auto_reversals | A |
| dhl_breakbulk_express_doc | B |
| dhl_medical_express_doc | C |
| dhl_express_worldwide_doc | D |
| dhl_express_9_00_nondoc | E |
| dhl_freight_worldwide_nondoc | F |
| dhl_domestic_economy_select_doc | G |
| dhl_economy_select_nondoc | H |
| dhl_domestic_express_9_00_doc | I |
| dhl_jumbo_box_nondoc | J |
| dhl_express_9_00_doc | K |
| dhl_express_10_30_doc | L |
| dhl_express_10_30_nondoc | M |
| dhl_domestic_express_doc | N |
| dhl_domestic_express_10_30_doc | O |
| dhl_express_worldwide_nondoc | P |
| dhl_medical_express_nondoc | Q |
| dhl_globalmail_business_doc | R |
| dhl_same_day_doc | S |
| dhl_express_12_00_doc | T |
| dhl_express_worldwide_ecx_doc | U |
| dhl_europack_nondoc | V |
| dhl_economy_select_doc | W |
| dhl_express_envelope_doc | X |
| dhl_express_12_00_nondoc | Y |
| dhl_destination_charges | Z |
| dhl_express_all | None |
### Deutsche Post DHL
| Code | Service Name |
| ------------ | ------------ |
| dpdhl_paket | V01PAK |
| dpdhl_paket_international | V53WPAK |
| dpdhl_europaket | V54EPAK |
| dpdhl_paket_connect | V55PAK |
| dpdhl_warenpost | V62WP |
| dpdhl_warenpost_international | V66WPI |
| dpdhl_retoure | |
---
## Parcel Templates
Use any of the following templates when you ship with special carrier packaging.
### Canada Post
| Code | Dimensions |
| ------------ | ------------ |
| canadapost_mailing_box | 10.2 x 15.2 x 1.0 cm |
| canadapost_extra_small_mailing_box | 14.0 x 14.0 x 14.0 cm |
| canadapost_small_mailing_box | 28.6 x 22.9 x 6.4 cm |
| canadapost_medium_mailing_box | 31.0 x 23.5 x 13.3 cm |
| canadapost_large_mailing_box | 38.1 x 30.5 x 9.5 cm |
| canadapost_extra_large_mailing_box | 40.0 x 30.5 x 21.6 cm |
| canadapost_corrugated_small_box | 42.0 x 32.0 x 32.0 cm |
| canadapost_corrugated_medium_box | 46.0 x 38.0 x 32.0 cm |
| canadapost_corrugated_large_box | 46.0 x 46.0 x 40.6 cm |
| canadapost_xexpresspost_certified_envelope | 26.0 x 15.9 x 1.5 cm |
| canadapost_xexpresspost_national_large_envelope | 40.0 x 29.2 x 1.5 cm |
### FedEx
| Code | Dimensions |
| ------------ | ------------ |
| fedex_envelope_legal_size | 9.5 x 15.5 x 1 in |
| fedex_padded_pak | 11.75 x 14.75 x 1 in |
| fedex_polyethylene_pak | 12.0 x 15.5 x 1 in |
| fedex_clinical_pak | 13.5 x 18.0 x 1 in |
| fedex_small_box | 12.25 x 10.9 x 1.5 in |
| fedex_medium_box | 13.25 x 11.5 x 2.38 in |
| fedex_large_box | 17.88 x 12.38 x 3.0 in |
| fedex_extra_large_box | 11.88 x 11.0 x 10.75 in |
| fedex_10_kg_box | 15.81 x 12.94 x 10.19 in |
| fedex_25_kg_box | 21.56 x 16.56 x 13.19 in |
| fedex_tube | 38.0 x 6.0 x 6.0 in |
### Purolator
| Code | Dimensions |
| ------------ | ------------ |
| purolator_express_envelope | 12.5 x 16 x 1.5 in |
| purolator_express_pack | 12.5 x 16 x 1.0 in |
| purolator_express_box | 18 x 12 x 3.5 in |
### TNT
| Code | Dimensions |
| ------------ | ------------ |
| tnt_envelope_doc | 35.0 x 1.0 x 27.5 cm |
| tnt_satchel_bag1 | 40.0 x 1.0 x 30.0 cm |
| tnt_satchel_bag2 | 47.5 x 1.0 x 38.0 cm |
| tnt_box_B | 29.5 x 19.0 x 40.0 cm |
| tnt_box_C | 29.5 x 29.0 x 40.0 cm |
| tnt_box_D | 39.5 x 29.0 x 50.0 cm |
| tnt_box_E | 39.5 x 49.5 x 44.0 cm |
| tnt_medpack_ambient | 18.0 x 12.0 x 23.0 cm |
| tnt_medpack_fronzen_10 | 37.0 x 35.5 x 40.0 cm |
### UPS
| Code | Dimensions |
| ------------ | ------------ |
| ups_small_express_box | 13.0 x 11.0 x 2.0 in |
| ups_medium_express_box | 16.0 x 11.0 x 3.0 in |
| ups_large_express_box | 18.0 x 13.0 x 3.0 in |
| ups_express_tube | 38.0 x 6.0 x 6.0 in |
| ups_express_pak | 16.0 x 11.75 x 1.5 in |
| ups_world_document_box | 17.5 x 12.5 x 3.0 in |
### DHL Express
| Code | Dimensions |
| ------------ | ------------ |
| dhl_express_envelope | 35.0 x 27.5 x 1.0 cm |
| dhl_express_standard_flyer | 40.0 x 30.0 x 1.5 cm |
| dhl_express_large_flyer | 47.5 x 37.5 x 1.5 cm |
| dhl_express_box_2 | 33.7 x 18.2 x 10.0 cm |
| dhl_express_box_3 | 33.6 x 32.0 x 5.2 cm |
| dhl_express_box_4 | 33.7 x 32.2 x 18.0 cm |
| dhl_express_box_5 | 33.7 x 32.2 x 34.5 cm |
| dhl_express_box_6 | 41.7 x 35.9 x 36.9 cm |
| dhl_express_box_7 | 48.1 x 40.4 x 38.9 cm |
| dhl_express_box_8 | 54.2 x 44.4 x 40.9 cm |
| dhl_express_tube | 96.0 x 15.0 x 15.0 cm |
| dhl_didgeridoo_box | 13.0 x 13.0 x 162.0 cm |
| dhl_jumbo_box | 45.0 x 42.7 x 33.0 cm |
| dhl_jumbo_box_junior | 39.9 x 34.0 x 24.1 cm |
...