v1.2.0

Logistics

public.address:read public.address:write public.address\_validation:write public.address\_validation\_domestic:write public.asset:read public.asset:write public.box:read public.box:write public.courier:read public.courier:write public.courier\_service:read public.credit:read public.hs\_code:read public.label:write public.payment\_source:read public.rate:read public.reference:read public.setting:read public.shipment:read public.shipment:write public.store:read public.tag:read public.tag:write public.track:read public.track\_3p:read public.track\_3p:write public.transaction\_record:read

Action

Description

Required scopes

Get Account

Retrieve information about current account

Get Account Settings

Retrieve account settings

List Countries

Retrieve a list of countries

List All States

Retrieve a list of states

List All Addresses

Retrieve a list of all addresses ordered by date of creation

Validate A Single Address

Create an address validation for international addresses

Create An Address

Create a new address

Update An Address

Update an address in your account

Activate An Address

Activate specific address

Deactivate An Address

Deactivate specific address

Validate A Single Domestic (US) Address

Create a domestic address validation for US addresses

Create Asset

Upload a new asset

List Assets

Retrieve a list of assets

Update Asset

Update an existing asset

Delete Asset

Delete an asset

Deactivate Asset

Deactivate a specific asset

Activate Asset

Activate a specific asset

List All Boxes

Retrieve a list of available courier boxes and your custom boxes

Create A Box

Create a box

Update A Box

Update a box in your account

Delete A Box

Delete a box from your account

List All Couriers

Retrieve a list of active couriers

Create A Courier

Create a new courier account

Get A Courier

Retrieve details of a courier

Delete A Courier

Delete a LYOC courier

List All Courier Services Of A Courier

Retrieve a list of courier services for selected courier

List All LYOC

Retrieve a list of available LYOC

Create Label

Create a new label for an existing shipment

Create Shipment

Create a new shipment

List Shipments

Retrieve a list of shipments with optional filters

Get Shipment

Retrieve details of a specific shipment

Update Shipment

Update shipment details

Delete Shipment

Delete a shipment that has not yet been shipped

List All Trackings

Retrieve tracking status and checkpoint history for shipments

List Transaction Records For A Shipment

List transaction records for a specific shipment

List Unavailable Couriers For A Shipment

List unavailable couriers and reasons for a specific shipment

Cancel A Shipment

Cancel a shipment that has been shipped

List All Item Categories

Retrieve a list of item categories

List HS Codes

Retrieve a list of HS codes

List All Stores

Retrieve a list of stores

List All Tags

Retrieve a list of tags

Create A Tag

Create a new tag

List All Trackings

Retrieve a list of trackings available with your account

Get A Tracking

Show a single tracking in your account

Delete A Tracking

Delete a single tracking from your account

Create A Tracking

Create a single tracking in your account

List Supported Couriers

List supported couriers for tracking

List External Courier Services

List courier services that do not support label generation but are trackable

Authorizations Batches Couriers Credits Insurance Labels Shipments Trackings Webhooks

14 events

Event

Description