POD Super System Endpoints (1.0.0)

Download OpenAPI specification:

Authentication

Preflight options

Authorizations:

apiKeybearerAuth

Responses

Response samples

default

Content type

application/json

{"error": "Refresh Token expired. Please log in to start a new session.",
"error_code": "refresh_token_expired",
"devmessage": {"class": "string",
"code": 0,
"message": "string",
"location": "string",
"line": 0
}
}

Get the current user

Get the user from the current session.

Authorizations:

apiKeybearerAuth

Responses

Response samples

200
default

Content type

application/json

{"id": 42,
"name": "sebi",
"loggedIn": true
}

Login User

Authenticates the user.

Authorizations:

apiKeybasicAuth

Request Body schema: multipart/form-data

username	string
password	string <password>

Responses

Response samples

200
default

Content type

application/json

{"username": "sebi",
"refresh_token": "string"
}

Logout User

Logs the user out and terminates their current session.

Authorizations:

apiKeybearerAuth

Responses

Response samples

200
default

Content type

application/json

{"success": true
}

Preflight options

Authorizations:

apiKeybearerRefreshAuth

Responses

Response samples

default

Content type

application/json

{"error": "Refresh Token expired. Please log in to start a new session.",
"error_code": "refresh_token_expired",
"devmessage": {"class": "string",
"code": 0,
"message": "string",
"location": "string",
"line": 0
}
}

Renew access token. Only possible if the auth-type is Double JWT

Authorizations:

apiKeybearerRefreshAuth

Responses

Response samples

200
default

Content type

application/json

{"refresh_token": "string",
"access_token": "string"
}

Order

Create an Order

Creates a new order with shipping details and order line items.

Case 1: You do not provide the shipping label, therefore shipping is required.
Case 2: You do provide the shipping label (in order_meta_assets), therefore shipping is not required / can be ignored (although still recommended).

Authorizations:

apiKey

Request Body schema: application/json
required

One of

test

boolean

Default: false

Set to true if testing API integration. Set to false if this is a real order.

pickup

boolean

Default: false

For advanced integrations only that allow for non-shippable orders. Will automatically be set to false if your integration doesn't support this feature.

required

object (Shipping)

Where the order is to be shipped / the address of the end-customer.

provider_order_id

required

string

The Order ID / Order Number in your system.
Example: 123456
Example: ABC-123456

provider_order_date

required

string <date-time>

The date of the original customer order. Please use UTC.

provider_order_callback_url

required

string <uri>

The URL to send the order status updates to. This is a webhook URL.

provider_sales_channel

string

The name of the marketplace / sales channel the order originates from.
Example: Amazon
Example: Temu

shipping_carrier

string

Enum: "usps" "ups" "fedex" "dhl" "passportglobal" "gofo-express" "uniuni"

shipping_service

string

Shipping Carriers and Shipping Services Table

Shipping Carrier Title	Shipping Carrier Code	Shipping Service Title	Shipping Service Code
USPS	usps	USPS FIRST CLASS	usps-first-class
USPS	usps	USPS PRIORITY	usps-priority
USPS	usps	USPS PRIORITY COMMERCIAL	usps-priority-commercial
USPS	usps	USPS EXPRESS	usps-express
USPS	usps	USPS EXPRESS COMMERCIAL	usps-express-commercial
USPS	usps	USPS EXPRESS SH	usps-express-sh
USPS	usps	USPS EXPRESS SH COMMERCIAL	usps-express-sh-commercial
USPS	usps	USPS EXPRESS HFP	usps-express-hfp
USPS	usps	USPS COMMERCIAL	usps-commercial
USPS	usps	USPS BPM	usps-bpm
USPS	usps	USPS PARCEL	usps-parcel
USPS	usps	USPS MEDIA	usps-media
USPS	usps	USPS LIBRARY	usps-library
USPS	usps	USPS ALL	usps-all
USPS	usps	USPS ONLINE	usps-online
USPS	usps	USPS Ground Advantage	usps-ground-advantage
USPS	usps	USPS First Class Mail International	usps-first-class-mail-international
USPS	usps	USPS First Class Package International Service	usps-first-class-package-international-service
USPS	usps	USPS Priority Mail International	usps-priority-mail-international
USPS	usps	USPS Express Mail International	usps-express-mail-international
UPS	ups	UPS Next Day Air	ups-next-day-air
UPS	ups	UPS Second Day Air	ups-second-day-air
UPS	ups	UPS Ground	ups-ground
UPS	ups	UPS Worldwide Express	ups-worldwide-express
UPS	ups	UPS Worldwide Expedited	ups-worldwide-expedited
UPS	ups	UPS Standard	ups-standard
UPS	ups	UPS Three-Day Select	ups-three-day-select
UPS	ups	UPS Next Day Air Saver	ups-next-day-air-saver
UPS	ups	UPS Next Day Air Early AM	ups-next-day-air-early-am
UPS	ups	UPS Worldwide Express Plus	ups-worldwide-express-plus
UPS	ups	UPS Second Day Air AM	ups-second-day-air-am
UPS	ups	UPS Saver (UPS Worldwide Express Saver)	ups-saver
UPS	ups	UPS SurePost Less than 1lb	ups-surepost-less-than-1lb
UPS	ups	UPS SurePost 1 lb or Greater (aka UPS Ground Saver)	ups-surepost-1-lb-or-greater
UPS	ups	UPS SurePost BPM	ups-surepost-bpm
UPS	ups	UPS SurePost Media	ups-surepost-media
UPS	ups	UPS First-Class Mail	ups-first-class-mail
UPS	ups	UPS Priority Mail	ups-priority-mail
UPS	ups	UPS Expedited Mail Innovations	ups-expedited-mail-innovations
UPS	ups	UPS Priority Mail Innovations	ups-priority-mail-innovations
UPS	ups	UPS Economy Mail Innovations	ups-economy-mail-innovations
FedEx	fedex	FedEx Europe First International Priority	fedex-europe-first-international-priority
FedEx	fedex	FedEx 1Day Freight	fedex-1day-freight
FedEx	fedex	FedEx 2Day	fedex-2day
FedEx	fedex	FedEx 2Day A.M.	fedex-2day-am
FedEx	fedex	FedEx 2Day Freight	fedex-2day-freight
FedEx	fedex	FedEx 3Day Freight	fedex-3day-freight
FedEx	fedex	FedEx Express Saver	fedex-express-saver
FedEx	fedex	FedEx First Freight	fedex-first-freight
FedEx	fedex	FedEx Freight Economy	fedex-freight-economy
FedEx	fedex	FedEx Freight	fedex-freight
FedEx	fedex	FedEx National Freight	fedex-national-freight
FedEx	fedex	FedEx Freight Priority	fedex-freight-priority
FedEx	fedex	FedEx Ground	fedex-ground
FedEx	fedex	FedEx First Overnight	fedex-first-overnight
FedEx	fedex	FedEx Home Delivery	fedex-home-delivery
FedEx	fedex	FedEx International Economy	fedex-international-economy
FedEx	fedex	FedEx International Economy Freight	fedex-international-economy-freight
FedEx	fedex	FedEx International First	fedex-international-first
FedEx	fedex	FedEx International Priority	fedex-international-priority
FedEx	fedex	FedEx International Priority Freight	fedex-international-priority-freight
FedEx	fedex	FedEx Priority Overnight	fedex-priority-overnight
FedEx	fedex	FedEx Ground Economy AKA SmartPost	fedex-ground-economy-aka-smartpost
FedEx	fedex	FedEx Standard Overnight	fedex-standard-overnight
PassportGlobal	passportglobal	Passport PriorityDdpDelcon	passport-priorityddpdelcon
PassportGlobal	passportglobal	Passport Priority DDP	passport-priority-ddp
PassportGlobal	passportglobal	Passport ePacket DDP	passport-epacket-ddp
PassportGlobal	passportglobal	Passport Express DDP	passport-express-ddp
PassportGlobal	passportglobal	Passport Priority DDU Delcon	passport-priority-ddu-delcon
PassportGlobal	passportglobal	Passport Priority DDU	passport-priority-ddu

required

Array of objects (OrderLineItemRequest)

Items in the order. Each item must have a unique order_line_item_id.

Array of objects (OrderMetaAssetRequest)

Additional files associated with this order. For example, a pre-made shipping label used to ship the fulfillment package, a packing list that is to be included in a fulfillment package, etc.

location

string

Default: "teale"

Enum: "teale" "penn"

Teale is West Coast of USA; Penn is East Coast of USA
Setting the location on the order level assigns all order line items to the same location (no order splitting). For advanced integrations only.

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

case 1

{"test": false,
"pickup": false,
"shipping": {"full_name": "Jason Smith",
"first_name": "Jason",
"last_name": "Smith",
"company_name": "ABC Corp.",
"street": "123 Main St.",
"street_2": "string",
"street_3": "string",
"city": "Los Angeles",
"state": "CA",
"postcode": "90001",
"country": "US",
"email": "jsmith@example.com",
"phone": "3105551212"
},
"provider_order_id": "1",
"provider_order_date": "2019-08-24T14:15:22Z",
"provider_order_callback_url": "http://example.com",
"provider_sales_channel": "string",
"shipping_carrier": "usps",
"shipping_service": "string",
"order_line_items": [{"order_line_item_id": "string",
"product_title": "string",
"quantity": 0,
"sku": "string",
"item_spec": "string",
"preview_urls": "string",
"location": "teale",
"order_line_item_assets": [{"asset_type": "artwork",
"url": "http://example.com",
"ppi": 0
}
]
}
],
"order_meta_assets": [{"asset_type": "packing-list",
"url": "http://example.com",
"reference_id": "string"
}
],
"location": "teale"
}

Response samples

201
default

Content type

application/json

{"id": 0
}

Callback payload samples

Callback

POST: Callback for order status updates

Content type

application/json

{"type": "shipments.created",
"timestamp": "2019-08-24T14:15:22Z",
"data": {"shipments": [{"id": 0,
"title": "string",
"shipping_carrier": "usps",
"shipping_service": "ups-next-day-air",
"combine_packages": false,
"shipment_fulfillments": [{"id": 0,
"tracking_number": "string",
"tracking_url": "http://example.com",
"fulfillment": {"id": 0,
"title": "string",
"fulfillment_line_items": [{"id": 0,
"order_line_item_id": "string",
"quantity": 0
}
]
}
}
],
"order_id": 0,
"order_status": "processing",
"provider_order_id": "1",
"provider_order_number": "1"
}
]
},
"event": "shipments.created"
}

Get an Order

Authorizations:

apiKey

path Parameters

id

required

integer <int64>

ID of the order to retrieve

Responses

Response samples

200
default

Content type

application/json

Example

case 1

{"id": 0,
"test": false,
"pickup": false,
"order_number": "string",
"order_date": "2019-08-24T14:15:22Z",
"operational_date": "2019-08-24T14:15:22Z",
"ship_by_date": "2019-08-24T14:15:22Z",
"provider": "string",
"order_status": "processing",
"biller": {"id": 0,
"name": "string",
"title": "string"
},
"provider_order_id": "1",
"provider_order_date": "2019-08-24T14:15:22Z",
"provider_order_callback_url": "http://example.com",
"provider_sales_channel": "string",
"shipping": {"full_name": "Jason Smith",
"first_name": "Jason",
"last_name": "Smith",
"company_name": "ABC Corp.",
"street": "123 Main St.",
"street_2": "string",
"street_3": "string",
"city": "Los Angeles",
"state": "CA",
"postcode": "90001",
"country": "US",
"email": "jsmith@example.com",
"phone": "3105551212"
},
"order_meta_assets": [{"id": 0,
"asset_type": "packing-list",
"url": "http://example.com",
"reference_id": "string"
}
],
"order_line_items": [{"id": 0,
"product": 0,
"order_line_item_id": "string",
"product_title": "string",
"quantity": 0,
"sku": "string",
"item_spec": "string",
"preview_urls": "string",
"location": "teale",
"order_line_item_assets": [{"asset_type": "artwork",
"url": "http://example.com",
"ppi": 0
}
]
}
],
"fulfillment_orders": [{"id": 0,
"location": "teale",
"fulfillment_order_line_items": [{"id": 0,
"order_line_item": 0,
"quantity": 0,
"fulfillable_quantity": 0
}
],
"fulfillments": [{"id": 0,
"title": "string",
"fulfillment_line_items": [{"id": 0,
"fulfillment_order_line_item": 0,
"fulfillment_line_item_error": "artwork-not-printable",
"cancel": false,
"fulfillment_line_item_jobs": [{"id": 0,
"fulfillment_line_item_job_qc_status": "pass",
"fulfillment_line_item_job_qc_fail_reason": "defective-artwork-transfer"
}
]
}
],
"package_type": "string",
"fulfillment_status": "pending",
"ship_by_date": "2019-08-24T14:15:22Z",
"price": 0.1
}
],
"shipments": [{"id": 0,
"title": "string",
"shipping_carrier": "usps",
"shipping_service": "ups-next-day-air",
"combine_packages": false,
"shipment_fulfillments": [{"id": 0,
"tracking_number": "string",
"tracking_url": "http://example.com",
"fulfillment": {"id": 0,
"title": "string",
"fulfillment_line_items": [{"id": null,
"order_line_item_id": null,
"quantity": null
}
]
}
}
],
"order_id": 0,
"order_status": "processing",
"provider_order_id": "1",
"provider_order_number": "1"
}
]
}
],
"shipping_carrier": "usps",
"shipping_service": "string",
"location": "teale"
}

Update an Order

Authorizations:

apiKey

path Parameters

id

required

integer <int64>

ID of the order to update

Request Body schema: application/json
required

order_status	string Value: "canceled"
	object (Shipping) Where the order is to be shipped / the address of the end-customer.

Responses

Request samples

Payload

Content type

application/json

{"order_status": "canceled",
"shipping": {"full_name": "Jason Smith",
"first_name": "Jason",
"last_name": "Smith",
"company_name": "ABC Corp.",
"street": "123 Main St.",
"street_2": "string",
"street_3": "string",
"city": "Los Angeles",
"state": "CA",
"postcode": "90001",
"country": "US",
"email": "jsmith@example.com",
"phone": "3105551212"
}
}

Response samples

200
default

Content type

application/json

Example

case 1

{"id": 0,
"test": false,
"pickup": false,
"order_number": "string",
"order_date": "2019-08-24T14:15:22Z",
"operational_date": "2019-08-24T14:15:22Z",
"ship_by_date": "2019-08-24T14:15:22Z",
"provider": "string",
"order_status": "processing",
"biller": {"id": 0,
"name": "string",
"title": "string"
},
"provider_order_id": "1",
"provider_order_date": "2019-08-24T14:15:22Z",
"provider_order_callback_url": "http://example.com",
"provider_sales_channel": "string",
"shipping": {"full_name": "Jason Smith",
"first_name": "Jason",
"last_name": "Smith",
"company_name": "ABC Corp.",
"street": "123 Main St.",
"street_2": "string",
"street_3": "string",
"city": "Los Angeles",
"state": "CA",
"postcode": "90001",
"country": "US",
"email": "jsmith@example.com",
"phone": "3105551212"
},
"order_meta_assets": [{"id": 0,
"asset_type": "packing-list",
"url": "http://example.com",
"reference_id": "string"
}
],
"order_line_items": [{"id": 0,
"product": 0,
"order_line_item_id": "string",
"product_title": "string",
"quantity": 0,
"sku": "string",
"item_spec": "string",
"preview_urls": "string",
"location": "teale",
"order_line_item_assets": [{"asset_type": "artwork",
"url": "http://example.com",
"ppi": 0
}
]
}
],
"fulfillment_orders": [{"id": 0,
"location": "teale",
"fulfillment_order_line_items": [{"id": 0,
"order_line_item": 0,
"quantity": 0,
"fulfillable_quantity": 0
}
],
"fulfillments": [{"id": 0,
"title": "string",
"fulfillment_line_items": [{"id": 0,
"fulfillment_order_line_item": 0,
"fulfillment_line_item_error": "artwork-not-printable",
"cancel": false,
"fulfillment_line_item_jobs": [{"id": 0,
"fulfillment_line_item_job_qc_status": "pass",
"fulfillment_line_item_job_qc_fail_reason": "defective-artwork-transfer"
}
]
}
],
"package_type": "string",
"fulfillment_status": "pending",
"ship_by_date": "2019-08-24T14:15:22Z",
"price": 0.1
}
],
"shipments": [{"id": 0,
"title": "string",
"shipping_carrier": "usps",
"shipping_service": "ups-next-day-air",
"combine_packages": false,
"shipment_fulfillments": [{"id": 0,
"tracking_number": "string",
"tracking_url": "http://example.com",
"fulfillment": {"id": 0,
"title": "string",
"fulfillment_line_items": [{"id": null,
"order_line_item_id": null,
"quantity": null
}
]
}
}
],
"order_id": 0,
"order_status": "processing",
"provider_order_id": "1",
"provider_order_number": "1"
}
]
}
],
"shipping_carrier": "usps",
"shipping_service": "string",
"location": "teale"
}

Get Order Statuses (Bulk)

Get the status of multiple orders at once by providing an array of order IDs.

Authorizations:

apiKey

Request Body schema: application/json
required

order_ids

required

Array of integers <int64> [ items <int64 > ]

Array of order IDs to retrieve statuses for

Responses

Request samples

Payload

Content type

application/json

{"order_ids": [12345,
12346,
12347
]
}

Response samples

200
default

Content type

application/json

{"data": [{"id": 0,
"order_status": "string"
}
],
"meta": {"requested": 0,
"found": 0,
"not_found": [0
]
}
}

User

Get a User

Authorizations:

apiKey

Responses

Response samples

default

Content type

application/json

{"error": "Refresh Token expired. Please log in to start a new session.",
"error_code": "refresh_token_expired",
"devmessage": {"class": "string",
"code": 0,
"message": "string",
"location": "string",
"line": 0
}
}

POD Super System Endpoints (1.0.0)

Authentication

Preflight options

Authorizations:

Responses

Response samples

Get the current user

Authorizations:

Responses

Response samples

Login User

Authorizations:

Request Body schema: multipart/form-data

Responses

Response samples

Logout User

Authorizations:

Responses

Response samples

Preflight options

Authorizations:

Responses

Response samples

Renew access token. Only possible if the auth-type is Double JWT

Authorizations:

Responses

Response samples

Order

Create an Order

Authorizations:

Request Body schema: application/jsonrequired

Responses

Callbacks

Request samples

Response samples

Callback payload samples

Get an Order

Authorizations:

path Parameters

Responses

Response samples

Update an Order

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Order Statuses (Bulk)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

User

Get a User

Authorizations:

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required