Ordoro API Reference (1.0.0)

Download OpenAPI specification:Download

Introduction

The Ordoro API can be used to access data or integrate to add functionality to Ordoro. The Ordoro API uses the application/json Content-Type.

Any routes with a /v3 designation will not allow trailing slashes, while other routes and endpoints require a trailing slash.

Authentication

The Ordoro API uses Basic HTTP Authentication. Create API keys via Settings > Account Settings > API Keys in the Ordoro app and use those for Basic Authentication in your API requests.

APIKey

Use an Ordoro API key as the Basic Authentication username.

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

Additional Resources

For code examples showing how to use the API, see our API examples repository.

API Responses

Most endpoints return either a list of objects or a single object instance. They share similar response shapes.

List Endpoints

List endpoints respond with the following parameters:

Name	Type	Description
`count`	int	The total number of objects returned by a query, not necessarily the number of objects included in a response.
`limit`	int	The maximum number of objects returned per request. Defaults to 10, with a maximum of 100. Set this as a URL parameter. Refer to individual endpoints for legacy exceptions.
`offset`	int	The number of objects being offset in the response. Set this as a URL parameter.
`<model name>`	array	An array of objects. The model name is singular. For example, `/v3/order` returns an `order` array, not `orders`.

Example response for the /v3/order list endpoint:

{
  "count": 2,
  "limit": 10,
  "offset": 0,
  "order": [
    {},
    {}
  ]
}

Instance Endpoints

Instance endpoints return a single instance of a serialized model. /v3/order/{order_number} is an example of an instance endpoint.

Error Handling

Error responses contain the following parameters:

Name	Type	Description
`error_message`	string	A human-readable error message.
`param`	string or `null`	The name of the corresponding parameter, or `null` for general errors.

Rate Limiting

API requests are limited to 500 requests per minute. Requests over this threshold receive a 429 status code.

Address

Get Address

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string

Responses

Post Address

Authorizations:

APIKey

Request Body schema: application/json

company	string <= 255 characters
name	string <= 255 characters
street1	string <= 255 characters
street2	string <= 255 characters
city	string <= 255 characters
state	string <= 255 characters
zip	string <= 255 characters
country	string <= 255 characters
email	string <= 255 characters
email_cc	string <= 255 characters
email_bcc	string <= 255 characters
phone	string <= 255 characters
fax	string <= 255 characters
reference_number	string <= 255 characters
cart_address_id	string <= 255 characters
validation	string

Responses

Request samples

Payload

Content type

application/json

{"company": "string",
"name": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"validation": "string"
}

Get Address Search

Authorizations:

APIKey

query Parameters

q	string >= 3 characters

Responses

Get Address

Authorizations:

APIKey

path Parameters

address_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string

Responses

Post Address

Authorizations:

APIKey

path Parameters

address_id

required

integer

Request Body schema: application/json

company	string <= 255 characters
name	string <= 255 characters
street1	string <= 255 characters
street2	string <= 255 characters
city	string <= 255 characters
state	string <= 255 characters
zip	string <= 255 characters
country	string <= 255 characters
email	string <= 255 characters
email_cc	string <= 255 characters
email_bcc	string <= 255 characters
phone	string <= 255 characters
fax	string <= 255 characters
reference_number	string <= 255 characters
cart_address_id	string <= 255 characters
validation	string

Responses

Request samples

Payload

Content type

application/json

{"company": "string",
"name": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"validation": "string"
}

Post Address Validate

Authorizations:

APIKey

path Parameters

address_id

required

integer

Responses

Api Key

Delete A P I Key

Authorizations:

APIKey

Responses

Get A P I Key

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 0,
"limit": 10,
"offset": 0,
"api_key": [{"id": 0,
"name": "string",
"client_id": "string",
"client_secret": "string",
"archive_date": "string",
"created": "string",
"updated": "string",
"company_id": 0,
"user_id": 0
}
]
}

Post A P I Key

Authorizations:

APIKey

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Put A P I Key

Authorizations:

APIKey

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Delete A P I Key

Authorizations:

APIKey

path Parameters

api_key_id

required

integer

Responses

Get A P I Key

Authorizations:

APIKey

path Parameters

api_key_id

required

integer

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"client_id": "string",
"client_secret": "string",
"archive_date": "string",
"created": "string",
"updated": "string",
"company_id": 0,
"user_id": 0
}

Post A P I Key

Authorizations:

APIKey

path Parameters

api_key_id

required

integer

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Put A P I Key

Authorizations:

APIKey

path Parameters

api_key_id

required

integer

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

App Message

Get App Message

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string

Responses

Get App Message

Authorizations:

APIKey

path Parameters

app_message_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string

Responses

Batch

Delete Batch

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Get Batch

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
reference_id	Array of strings
search	string
sort	string Enum: "created_date" "-created_date" "reference_id" "-reference_id" "updated_date" "-updated_date"
active	boolean

Responses

Response samples

Content type

application/json

{"batch": [{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}
],
"limit": 10,
"offset": 0,
"count": 0
}

Head Batch

Authorizations:

APIKey

Responses

Post Batch

Authorizations:

APIKey

Request Body schema: application/json

One of

reference_id required	string
internal_notes	string or null
order_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Put Batch

Authorizations:

APIKey

Request Body schema: application/json

reference_id	string
running_task	string
has_errors	boolean
internal_notes	string or null
archive_date	string or null

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"running_task": "string",
"has_errors": true,
"internal_notes": "string",
"archive_date": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Get Batch Summary

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
reference_id	Array of strings
search	string
sort	string Enum: "created_date" "-created_date" "reference_id" "-reference_id" "updated_date" "-updated_date"
active	boolean

Responses

Delete Batch

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Get Batch

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Head Batch

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Post Batch

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

One of

reference_id required	string
internal_notes	string or null
order_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Put Batch

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

reference_id	string
running_task	string
has_errors	boolean
internal_notes	string or null
archive_date	string or null

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"running_task": "string",
"has_errors": true,
"internal_notes": "string",
"archive_date": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Batch Action

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

comment	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"comment": "string",
"params": {"targets": { },
"actions": [{"data": { },
"type": "string",
"retain_output": true
}
],
"action": {"data": { },
"type": "string"
}
}
}

Response samples

Content type

application/json

{ }

Put Batch Action

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

complete	boolean
	object
success	boolean

Responses

Request samples

Payload

Content type

application/json

{"complete": true,
"errors": {"orders": { },
"batch": [ ]
},
"success": true
}

Response samples

Content type

application/json

{ }

Post Batch Action

Authorizations:

APIKey

path Parameters

reference_id required	string
batch_action_id required	integer

Request Body schema: application/json

comment	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"comment": "string",
"params": {"targets": { },
"actions": [{"data": { },
"type": "string",
"retain_output": true
}
],
"action": {"data": { },
"type": "string"
}
}
}

Response samples

Content type

application/json

{ }

Put Batch Action

Authorizations:

APIKey

path Parameters

reference_id required	string
batch_action_id required	integer

Request Body schema: application/json

complete	boolean
	object
success	boolean

Responses

Request samples

Payload

Content type

application/json

{"complete": true,
"errors": {"orders": { },
"batch": [ ]
},
"success": true
}

Response samples

Content type

application/json

{ }

Post Batch Action Start

Authorizations:

APIKey

path Parameters

reference_id required	string
batch_action_id required	integer

Responses

Response samples

Content type

application/json

{ }

Get Batch Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 35,
"limit": 1,
"offset": 0,
"comment": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Batch Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}

Delete Batch Controller Remove Or Add Orders

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

One of

order_numbers

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Put Batch Controller Remove Or Add Orders

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

One of

order_numbers

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Batch Render Line Label

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

layout_id	integer or null
	object
	object
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"layout_id": 0,
"card_layout_props": {"layout_name": "string"
},
"line_label_props": {"sort": ["reference_id"
],
"print_each_quantity": true,
"show_kit_components": true,
"reference_id_barcode_key": "string",
"reference_id_barcode_type": "string",
"sku_barcode_type": "string"
}
}

Post Batch Render L P P

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

name required	string
required	object
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"pdf_cache_paths": {"orders": [{"label": ["string"
],
"packing_list": ["string"
]
}
],
"pick_list": ["string"
]
}
}

Post Batch Render Pick List

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

name required	string
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Put Batch Sort

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

One of

order_numbers

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"order_numbers": [ ],
"created_date": "string",
"updated_date": "string",
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Bulk

Post Bulk Product

Authorizations:

APIKey

Request Body schema: application/json

bulk	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"bulk": ["string"
]
}

Cart

Get Cart

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
all	string
integration	Array of integers[ items ]

Responses

Post Cart

Authorizations:

APIKey

Request Body schema: application/json

_CART_TYPES	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"_CART_TYPES": "string",
"type": "string"
}

Put Cart

Authorizations:

APIKey

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Get Cart

Authorizations:

APIKey

path Parameters

cart_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
all	string
integration	Array of integers[ items ]

Responses

Post Cart

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Request Body schema: application/json

_CART_TYPES	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"_CART_TYPES": "string",
"type": "string"
}

Put Cart

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Delete Cart Auto Sync

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Responses

Get Cart Auto Sync

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Responses

Put Cart Auto Sync

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Request Body schema: application/json

frequency	string Enum: "10_minutes" "6_hours" "daily" "hourly" "monthly" The frequency the task will run
active	boolean Whether or not the task is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "10_minutes",
"active": true
}

Delete Cart Auto Sync

Authorizations:

APIKey

path Parameters

cart_id required	integer
task_type required	string

Responses

Get Cart Auto Sync

Authorizations:

APIKey

path Parameters

cart_id required	integer
task_type required	string

Responses

Put Cart Auto Sync

Authorizations:

APIKey

path Parameters

cart_id required	integer
task_type required	string

Request Body schema: application/json

frequency	string Enum: "10_minutes" "6_hours" "daily" "hourly" "monthly" The frequency the task will run
active	boolean Whether or not the task is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "10_minutes",
"active": true
}

Put Cart Integration

Authorizations:

APIKey

path Parameters

cart_id required	integer
integration_id required	integer

Request Body schema: application/json

	object The configuration for the cart integration bridge
active	boolean Whether or not the bridge is active

Responses

Request samples

Payload

Content type

application/json

{"config": {"export_tax_as_line_item": true
},
"active": true
}

Delete Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Responses

Get Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Responses

Post Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Responses

Put Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id

required

integer

Responses

Delete Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id required	integer
warehouse_id required	integer

Responses

Get Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id required	integer
warehouse_id required	integer

Responses

Post Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id required	integer
warehouse_id required	integer

Responses

Put Cart Warehouse

Authorizations:

APIKey

path Parameters

cart_id required	integer
warehouse_id required	integer

Responses

Company

Get Company

Authorizations:

APIKey

Responses

Put Company

Authorizations:

APIKey

Request Body schema: application/json

company_name	string <= 1024 characters
contact	string or null <= 255 characters
created	string <date-time>
promotional_code	string or null <= 50 characters
source	string or null <= 2048 characters
address	string or null
state_of_business	string or null <= 2 characters
website	string or null <= 200 characters
phone	string or null <= 50 characters
fax	string or null <= 50 characters
email	string or null <= 75 characters
billing_email	string or null <= 75 characters
footer	string or null
mail_sender	string or null
mail_sender_contact_id	integer or null
plan	string
shipper_currency	string <= 5 characters
currency_symbol	string <= 5 characters
app_message	object
	object

Responses

Request samples

Payload

Content type

application/json

{"company_name": "string",
"contact": "string",
"created": "2019-08-24T14:15:22Z",
"promotional_code": "string",
"source": "string",
"address": "string",
"state_of_business": "st",
"website": "string",
"phone": "string",
"fax": "string",
"email": "string",
"billing_email": "string",
"footer": "string",
"mail_sender": "string",
"mail_sender_contact_id": 0,
"plan": "string",
"shipper_currency": "strin",
"currency_symbol": "strin",
"app_message": { },
"print_node": {"api_key": "string",
"default_printer": "string",
"print_enabled": true,
"scale_enabled": true
}
}

Delete Company Apps

Authorizations:

APIKey

Responses

Get Company Apps

Authorizations:

APIKey

Responses

Patch Company Apps

Authorizations:

APIKey

Request Body schema: application/json

required

Array of objects[ items ]

Responses

Request samples

Payload

Content type

application/json

{"apps": [{"app": "string",
"interval": "string"
}
]
}

Delete Company Apps

Authorizations:

APIKey

path Parameters

app_id

required

string

Responses

Get Company Apps

Authorizations:

APIKey

path Parameters

app_id

required

string

Responses

Patch Company Apps

Authorizations:

APIKey

path Parameters

app_id

required

string

Request Body schema: application/json

required

Array of objects[ items ]

Responses

Request samples

Payload

Content type

application/json

{"apps": [{"app": "string",
"interval": "string"
}
]
}

Put Company Credit Card

Authorizations:

APIKey

Request Body schema: application/json

token	string <= 255 characters
payment_backend	string <= 255 characters
zip	string <= 32 characters
name	string <= 255 characters
expiry_month	integer
expiry_year	integer
last4	string <= 4 characters
card_type	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"token": "string",
"payment_backend": "string",
"zip": "string",
"name": "string",
"expiry_month": 0,
"expiry_year": 0,
"last4": "stri",
"card_type": "string"
}

Post Company Deactivate

Authorizations:

APIKey

Request Body schema: application/json

reason	object
send_email	boolean Default: true
deactivate_stripe	boolean Default: true
deactivated	string

Responses

Request samples

Payload

Content type

application/json

{"reason": { },
"send_email": true,
"deactivate_stripe": true,
"deactivated": "string"
}

Get Company Flag

Authorizations:

APIKey

Responses

Delete Company Flag

Authorizations:

APIKey

path Parameters

flag

required

string

Responses

Get Company Flag

Authorizations:

APIKey

path Parameters

flag

required

string

Responses

Post Company Flag

Authorizations:

APIKey

path Parameters

flag

required

string

Responses

Get Company Logo

Authorizations:

APIKey

Responses

Put Company Logo

Authorizations:

APIKey

Request Body schema: application/json

name	string
data	string
mime_type	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"data": "string",
"mime_type": "string"
}

Get Company Logo

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Put Company Logo

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name	string
data	string
mime_type	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"data": "string",
"mime_type": "string"
}

Delete Company Payment

Authorizations:

APIKey

Responses

Get Company Payment

Authorizations:

APIKey

query Parameters

is_default	boolean
payment_backend	string
limit	integer Default: 10
offset	integer Default: 0

Responses

Patch Company Payment

Authorizations:

APIKey

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"activation_response": {"access_token": "string",
"account": {"verification_status": "string"
},
"expired": true,
"error": { },
"pending_disconnect": true,
"consent_expiration_time": "string"
}
}

Post Company Payment

Authorizations:

APIKey

Request Body schema: application/json

account_id	string
activation_response	object
card_type	string For net_zero payments, we'll store info in the api
expiry_month	integer For net_zero payments, we'll store info in the api
expiry_year	integer For net_zero payments, we'll store info in the api
is_default	boolean Default: false
last4	string For net_zero payments, we'll store info in the api
name	string For net_zero payments, we'll store info in the api
payment_backend required	string
payment_response	object
payment_type	string Default: "ach" Enum: "ach" "credit-card" "same-day-ach" for ACH: same-day-ach, ach, or credit-card
	object
token	string For credit-card payments, we'll set up account info in the api
zip	string For net_zero payments, we'll store info in the api

Responses

Request samples

Payload

Content type

application/json

{"account_id": "string",
"activation_response": { },
"card_type": "string",
"expiry_month": 0,
"expiry_year": 0,
"is_default": false,
"last4": "string",
"name": "string",
"payment_backend": "string",
"payment_response": { },
"payment_type": "ach",
"processing_fee": {"ach": {"percentage": 0,
"cap": 0,
"charge": 0
},
"same-day": {"percentage": 0,
"cap": 0,
"charge": 0
},
"credit-card": {"percentage": 0,
"cap": 0,
"charge": 0
}
},
"token": "string",
"zip": "string"
}

Put Company Payment

Authorizations:

APIKey

Request Body schema: application/json

account_id	string
activation_response	object
is_default	boolean Used to signify the default payment account for postage purchases
locked	any Value: true Used to signify the payment account is locked
	object
payment_type	string for ACH: same-day-ach, standard-ach, or credit-card
	object

Responses

Request samples

Payload

Content type

application/json

{"account_id": "string",
"activation_response": { },
"is_default": true,
"locked": true,
"net_zero_config": {"card_type": "string",
"expiry_month": 0,
"expiry_year": 0,
"last4": "string",
"name": "string",
"token": "string",
"zip": "string"
},
"payment_type": "string",
"stripe_config": {"token": "string"
}
}

Get Company Payment Record

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
active	boolean Default: false
payment_account_id	Array of integers[ items ]
created_after	string <date-time>
created_before	string <date-time>
created_interval_type	string
created_interval_amount	number
created_interval_trunc	boolean
updated_after	string <date-time>
updated_before	string <date-time>
updated_interval_type	string
updated_interval_amount	number
updated_interval_trunc	boolean
timezone	string

Responses

Get Company Payment Record

Authorizations:

APIKey

path Parameters

payment_record_id

required

integer

Responses

Delete Company Payment

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Responses

Get Company Payment

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Responses

Patch Company Payment

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"activation_response": {"access_token": "string",
"account": {"verification_status": "string"
},
"expired": true,
"error": { },
"pending_disconnect": true,
"consent_expiration_time": "string"
}
}

Post Company Payment

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Request Body schema: application/json

account_id	string
activation_response	object
card_type	string For net_zero payments, we'll store info in the api
expiry_month	integer For net_zero payments, we'll store info in the api
expiry_year	integer For net_zero payments, we'll store info in the api
is_default	boolean Default: false
last4	string For net_zero payments, we'll store info in the api
name	string For net_zero payments, we'll store info in the api
payment_backend required	string
payment_response	object
payment_type	string Default: "ach" Enum: "ach" "credit-card" "same-day-ach" for ACH: same-day-ach, ach, or credit-card
	object
token	string For credit-card payments, we'll set up account info in the api
zip	string For net_zero payments, we'll store info in the api

Responses

Request samples

Payload

Content type

application/json

{"account_id": "string",
"activation_response": { },
"card_type": "string",
"expiry_month": 0,
"expiry_year": 0,
"is_default": false,
"last4": "string",
"name": "string",
"payment_backend": "string",
"payment_response": { },
"payment_type": "ach",
"processing_fee": {"ach": {"percentage": 0,
"cap": 0,
"charge": 0
},
"same-day": {"percentage": 0,
"cap": 0,
"charge": 0
},
"credit-card": {"percentage": 0,
"cap": 0,
"charge": 0
}
},
"token": "string",
"zip": "string"
}

Put Company Payment

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Request Body schema: application/json

account_id	string
activation_response	object
is_default	boolean Used to signify the default payment account for postage purchases
locked	any Value: true Used to signify the payment account is locked
	object
payment_type	string for ACH: same-day-ach, standard-ach, or credit-card
	object

Responses

Request samples

Payload

Content type

application/json

{"account_id": "string",
"activation_response": { },
"is_default": true,
"locked": true,
"net_zero_config": {"card_type": "string",
"expiry_month": 0,
"expiry_year": 0,
"last4": "string",
"name": "string",
"token": "string",
"zip": "string"
},
"payment_type": "string",
"stripe_config": {"token": "string"
}
}

Post Company Payment Add Funds

Authorizations:

APIKey

path Parameters

payment_account_id required	integer
payment_record_id required	integer

Responses

Response samples

Content type

application/json

{"apv_balance": 0,
"balance": 0,
"daily_purchase_limit": 0,
"ledger_balance": 0,
"todays_purchases": 0,
"payment_account_number": "string"
}

Post Company Payment Charge

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Request Body schema: application/json

amount required	number <double>
description required	string

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"description": "string"
}

Response samples

Content type

application/json

{"apv_balance": 0,
"balance": 0,
"daily_purchase_limit": 0,
"ledger_balance": 0,
"todays_purchases": 0,
"payment_account_number": "string"
}

Delete Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Responses

Get Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

query Parameters

limit	integer Default: 10
offset	integer Default: 0
active	boolean Default: false
created_after	string <date-time>
created_before	string <date-time>
created_interval_type	string
created_interval_amount	number
created_interval_trunc	boolean
updated_after	string <date-time>
updated_before	string <date-time>
updated_interval_type	string
updated_interval_amount	number
updated_interval_trunc	boolean
timezone	string

Responses

Post Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Request Body schema: application/json

amount

required

number

Responses

Request samples

Payload

Content type

application/json

{"amount": 0
}

Put Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id

required

integer

Request Body schema: application/json

active	boolean allow active to be set to False if something fails during the transfer
	object
request_id	string
	object

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"transfer": {"id": "string",
"amount": 0,
"created": "string",
"status": "string",
"network": "string"
},
"request_id": "string",
"authorization": {"id": "string",
"created": "string",
"decision": "string",
"payment_risk": "string",
"amount": 0
}
}

Delete Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id required	integer
payment_record_id required	integer

Responses

Get Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id required	integer
payment_record_id required	integer

Responses

Post Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id required	integer
payment_record_id required	integer

Request Body schema: application/json

amount

required

number

Responses

Request samples

Payload

Content type

application/json

{"amount": 0
}

Put Company Payment Transfer

Authorizations:

APIKey

path Parameters

payment_account_id required	integer
payment_record_id required	integer

Request Body schema: application/json

active	boolean allow active to be set to False if something fails during the transfer
	object
request_id	string
	object

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"transfer": {"id": "string",
"amount": 0,
"created": "string",
"status": "string",
"network": "string"
},
"request_id": "string",
"authorization": {"id": "string",
"created": "string",
"decision": "string",
"payment_risk": "string",
"amount": 0
}
}

Post Company Plan

Authorizations:

APIKey

Request Body schema: application/json

plan

string

Responses

Request samples

Payload

Content type

application/json

{"plan": "string"
}

Post Company Request Trust Score

Authorizations:

APIKey

Responses

Company Document

Delete Company Document

Authorizations:

APIKey

Responses

Get Company Document

Authorizations:

APIKey

Responses

Post Company Document

Authorizations:

APIKey

Responses

Put Company Document

Authorizations:

APIKey

Responses

Delete Company Document

Authorizations:

APIKey

path Parameters

document_id

required

integer

Responses

Get Company Document

Authorizations:

APIKey

path Parameters

document_id

required

integer

Responses

Post Company Document

Authorizations:

APIKey

path Parameters

document_id

required

integer

Responses

Put Company Document

Authorizations:

APIKey

path Parameters

document_id

required

integer

Responses

Get Company Document Data

Authorizations:

APIKey

path Parameters

document_id

required

integer

Responses

Contact

Delete Contact

Authorizations:

APIKey

Responses

Get Contact

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"limit": 0,
"offset": 0,
"count": 0,
"contact": [{"id": 0,
"nickname": "string",
"created_date": "string",
"updated_date": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}
}
]
}

Patch Contact

Authorizations:

APIKey

Request Body schema: application/json

nickname	string <= 255 characters
	object (update_address)
archived_date	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"nickname": "string",
"address": {"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"validate": true,
"set_revision_lock": true,
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"archived_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 0,
"nickname": "string",
"created_date": "string",
"updated_date": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}
}

Post Contact

Authorizations:

APIKey

Request Body schema: application/json

nickname required	string <= 255 characters
required	object (address_lite)

Responses

Request samples

Payload

Content type

application/json

{"nickname": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"revision_locked_fields": [ ]
}
}

Response samples

Content type

application/json

{"id": 0,
"nickname": "string",
"created_date": "string",
"updated_date": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}
}

Delete Contact

Authorizations:

APIKey

path Parameters

contact_id

required

integer

Responses

Get Contact

Authorizations:

APIKey

path Parameters

contact_id

required

integer

Responses

Response samples

Content type

application/json

{"id": 0,
"nickname": "string",
"created_date": "string",
"updated_date": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}
}

Patch Contact

Authorizations:

APIKey

path Parameters

contact_id

required

integer

Request Body schema: application/json

nickname	string <= 255 characters
	object (update_address)
archived_date	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"nickname": "string",
"address": {"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"validate": true,
"set_revision_lock": true,
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"archived_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 0,
"nickname": "string",
"created_date": "string",
"updated_date": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}
}

Post Contact

Authorizations:

APIKey

path Parameters

contact_id

required

integer

Request Body schema: application/json

nickname required	string <= 255 characters
required	object (address_lite)

Responses

Request samples

Payload

Content type

application/json

{"nickname": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"revision_locked_fields": [ ]
}
}

Response samples

Content type

application/json

{"id": 0,
"nickname": "string",
"created_date": "string",
"updated_date": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}
}

Filter Config

Delete Filter Config

Authorizations:

APIKey

Responses

Get Filter Config

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"limit": 0,
"offset": 0,
"count": 0,
"filter_config": [{"id": 0,
"name": "string",
"type": "string",
"filter": { },
"archived_date": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Post Filter Config

Authorizations:

APIKey

Request Body schema: application/json

name required	string <= 255 characters
type required	string Enum: "batch" "goods_receipt" "manufacturing_order" "order" "product" "purchase_order" "return_order" "stocktake"
filter required	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "batch",
"filter": { }
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"type": "string",
"filter": { },
"archived_date": "string",
"created_date": "string",
"updated_date": "string"
}

Put Filter Config

Authorizations:

APIKey

Request Body schema: application/json

name	string <= 255 characters
filter	object
archived_date	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"filter": { },
"archived_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"type": "string",
"filter": { },
"archived_date": "string",
"created_date": "string",
"updated_date": "string"
}

Delete Filter Config

Authorizations:

APIKey

path Parameters

filter_config_id

required

integer

Responses

Get Filter Config

Authorizations:

APIKey

path Parameters

filter_config_id

required

integer

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"type": "string",
"filter": { },
"archived_date": "string",
"created_date": "string",
"updated_date": "string"
}

Post Filter Config

Authorizations:

APIKey

path Parameters

filter_config_id

required

integer

Request Body schema: application/json

name required	string <= 255 characters
type required	string Enum: "batch" "goods_receipt" "manufacturing_order" "order" "product" "purchase_order" "return_order" "stocktake"
filter required	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "batch",
"filter": { }
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"type": "string",
"filter": { },
"archived_date": "string",
"created_date": "string",
"updated_date": "string"
}

Put Filter Config

Authorizations:

APIKey

path Parameters

filter_config_id

required

integer

Request Body schema: application/json

name	string <= 255 characters
filter	object
archived_date	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"filter": { },
"archived_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"type": "string",
"filter": { },
"archived_date": "string",
"created_date": "string",
"updated_date": "string"
}

Goods Receipt

Delete Goods Receipt

Authorizations:

APIKey

Responses

Get Goods Receipt

Authorizations:

APIKey

query Parameters

status	Array of strings Items Enum: "deleted" "new" "partial" "received"
po_id	Array of strings
sort	Array of strings Items Enum: "status" "-status" "goods_receipt_id" "-goods_receipt_id" "updated" "-updated" "created" "-created"
start_date	string Deprecated
end_date	string Deprecated

Responses

Post Goods Receipt

Authorizations:

APIKey

Request Body schema: application/json

po_id	string [ 1 .. 200 ] characters
goods_receipt_id	string <= 300 characters
received_lines	Array of strings
internal_notes	string

Responses

Request samples

Payload

Content type

application/json

{"po_id": "string",
"goods_receipt_id": "string",
"received_lines": ["string"
],
"internal_notes": "string"
}

Put Goods Receipt

Authorizations:

APIKey

Request Body schema: application/json

goods_receipt_id	string <= 300 characters
received_lines	Array of strings
internal_notes	string

Responses

Request samples

Payload

Content type

application/json

{"goods_receipt_id": "string",
"received_lines": ["string"
],
"internal_notes": "string"
}

Delete Goods Receipt

Authorizations:

APIKey

path Parameters

goods_receipt_id

required

string

Responses

Get Goods Receipt

Authorizations:

APIKey

path Parameters

goods_receipt_id

required

string

Responses

Post Goods Receipt

Authorizations:

APIKey

path Parameters

goods_receipt_id

required

string

Request Body schema: application/json

po_id	string [ 1 .. 200 ] characters
goods_receipt_id	string <= 300 characters
received_lines	Array of strings
internal_notes	string

Responses

Request samples

Payload

Content type

application/json

{"po_id": "string",
"goods_receipt_id": "string",
"received_lines": ["string"
],
"internal_notes": "string"
}

Put Goods Receipt

Authorizations:

APIKey

path Parameters

goods_receipt_id

required

string

Request Body schema: application/json

goods_receipt_id	string <= 300 characters
received_lines	Array of strings
internal_notes	string

Responses

Request samples

Payload

Content type

application/json

{"goods_receipt_id": "string",
"received_lines": ["string"
],
"internal_notes": "string"
}

Get Goods Receipt Comment

Authorizations:

APIKey

path Parameters

goods_receipt_id

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 35,
"limit": 1,
"offset": 0,
"comment": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Goods Receipt Comment

Authorizations:

APIKey

path Parameters

goods_receipt_id

required

string

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}

Put Goods Receipt Line

Authorizations:

APIKey

path Parameters

goods_receipt_id required	string
goods_receipt_item_id required	integer

Request Body schema: application/json

quantity

integer

Responses

Request samples

Payload

Content type

application/json

{"quantity": 0
}

Integration

Delete Integration

Authorizations:

APIKey

Responses

Get Integration

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
vendor	string
type	string
all	string

Responses

Post Integration

Authorizations:

APIKey

Request Body schema: application/json

vendor

string

Responses

Request samples

Payload

Content type

application/json

{"vendor": "string"
}

Put Integration

Authorizations:

APIKey

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Delete Integration

Authorizations:

APIKey

path Parameters

integration_id

required

integer

Responses

Get Integration

Authorizations:

APIKey

path Parameters

integration_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
vendor	string
type	string
all	string

Responses

Post Integration

Authorizations:

APIKey

path Parameters

integration_id

required

integer

Request Body schema: application/json

vendor

string

Responses

Request samples

Payload

Content type

application/json

{"vendor": "string"
}

Put Integration

Authorizations:

APIKey

path Parameters

integration_id

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Put Integration Cart

Authorizations:

APIKey

path Parameters

integration_id required	integer
cart_id required	integer

Request Body schema: application/json

	object The configuration for the cart integration bridge
active	boolean Whether or not the bridge is active

Responses

Request samples

Payload

Content type

application/json

{"config": {"export_tax_as_line_item": true
},
"active": true
}

Inventory Transfer

Get Inventory Transfer

Authorizations:

APIKey

query Parameters

created_after	string <date-time>
created_before	string <date-time>
created_interval_type	string
created_interval_amount	number
created_interval_trunc	boolean
limit	integer [ 1 .. 100 ] Default: 10
offset	integer >= 0 Default: 0
receiving_warehouse_id	Array of integers[ items ]
search	string
sending_warehouse_id	Array of integers[ items ]
sku	Array of strings
sort	Array of strings Items Enum: "created" "-created" "updated" "-updated"
timezone	string
updated_after	string <date-time>
updated_before	string <date-time>
updated_interval_type	string
updated_interval_amount	number
updated_interval_trunc	boolean

Responses

Response samples

Content type

application/json

{"count": 0,
"limit": 0,
"offset": 0,
"inventory_transfer": [{"transfer_id": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"transfer_notes": "string",
"sending_warehouse": {"id": 0,
"name": "string"
},
"receiving_warehouse": {"id": 0,
"name": "string"
},
"lines": [{"id": 0,
"line_notes": "string",
"name": "string",
"sku": "string",
"quantity": 0
}
]
}
]
}

Post Inventory Transfer

Authorizations:

APIKey

Request Body schema: application/json

sending_warehouse_id required	integer
receiving_warehouse_id required	integer
transfer_notes	string or null
required	Array of objects non-empty [ items ]

Responses

Request samples

Payload

Content type

application/json

{"sending_warehouse_id": 0,
"receiving_warehouse_id": 0,
"transfer_notes": "string",
"lines": [{"sku": "string",
"quantity": 0,
"line_notes": "string"
}
]
}

Put Inventory Transfer

Authorizations:

APIKey

Responses

Get Inventory Transfer

Authorizations:

APIKey

path Parameters

transfer_id

required

string

Responses

Response samples

Content type

application/json

{"transfer_id": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"transfer_notes": "string",
"sending_warehouse": {"id": 0,
"name": "string"
},
"receiving_warehouse": {"id": 0,
"name": "string"
},
"lines": [{"id": 0,
"line_notes": "string",
"name": "string",
"sku": "string",
"quantity": 0
}
]
}

Post Inventory Transfer

Authorizations:

APIKey

path Parameters

transfer_id

required

string

Request Body schema: application/json

sending_warehouse_id required	integer
receiving_warehouse_id required	integer
transfer_notes	string or null
required	Array of objects non-empty [ items ]

Responses

Request samples

Payload

Content type

application/json

{"sending_warehouse_id": 0,
"receiving_warehouse_id": 0,
"transfer_notes": "string",
"lines": [{"sku": "string",
"quantity": 0,
"line_notes": "string"
}
]
}

Put Inventory Transfer

Authorizations:

APIKey

path Parameters

transfer_id

required

string

Responses

Label

Get Label Raw

Authorizations:

APIKey

path Parameters

label_id

required

integer

Responses

Label Info

Get Label Info

Authorizations:

APIKey

query Parameters

limit	integer Default: 100
offset	integer Default: 0
o	Array of strings
id	Array of numbers[ items ]

Responses

Put Label Info

Authorizations:

APIKey

Request Body schema: application/json

config	object
	object or null
error_message	string or null
return_orders	Array of strings
type	string

Responses

Request samples

Payload

Content type

application/json

{"config": { },
"rates": {"list": [{ }
]
},
"error_message": "string",
"return_orders": ["string"
],
"type": "string"
}

Get Label Info

Authorizations:

APIKey

path Parameters

label_info_id

required

integer

Responses

Put Label Info

Authorizations:

APIKey

path Parameters

label_info_id

required

integer

Request Body schema: application/json

config	object
	object or null
error_message	string or null
return_orders	Array of strings
type	string

Responses

Request samples

Payload

Content type

application/json

{"config": { },
"rates": {"list": [{ }
]
},
"error_message": "string",
"return_orders": ["string"
],
"type": "string"
}

Layout

Delete Layout

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}

Get Layout

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
type	string

Responses

Response samples

Content type

application/json

{"layout": [{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}
],
"limit": 10,
"offset": 0,
"count": 0
}

Post Layout

Authorizations:

APIKey

Request Body schema: application/json

name required	string
type required	string
layout required	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "string",
"layout": { }
}

Response samples

Content type

application/json

{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}

Put Layout

Authorizations:

APIKey

Request Body schema: application/json

layout

required

object

Responses

Request samples

Payload

Content type

application/json

{"layout": { }
}

Response samples

Content type

application/json

{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}

Delete Layout

Authorizations:

APIKey

path Parameters

layout_id

required

integer

Responses

Response samples

Content type

application/json

{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}

Get Layout

Authorizations:

APIKey

path Parameters

layout_id

required

integer

Responses

Response samples

Content type

application/json

{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}

Post Layout

Authorizations:

APIKey

path Parameters

layout_id

required

integer

Request Body schema: application/json

name required	string
type required	string
layout required	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "string",
"layout": { }
}

Response samples

Content type

application/json

{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}

Put Layout

Authorizations:

APIKey

path Parameters

layout_id

required

integer

Request Body schema: application/json

layout

required

object

Responses

Request samples

Payload

Content type

application/json

{"layout": { }
}

Response samples

Content type

application/json

{"id": 0,
"layout": { },
"name": "string",
"type": "string"
}

Manufacturing Order

Get Manufacturing Order

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
created_after	string <date-time>
created_before	string <date-time>
created_interval_type	string
created_interval_amount	number
created_interval_trunc	boolean
reference_id	Array of strings
search	string
status	Array of strings
tag	Array of strings
tag_filter_by	string Enum: "or" "and" "only" "not"
untagged	boolean
warehouse_id	Array of integers[ items ]
sort	Array of strings Items Enum: "reference_id" "-reference_id" "status" "-status" "warehouse_name" "-warehouse_name" "created_date" "-created_date" "updated_date" "-updated_date"

Responses

Response samples

Content type

application/json

{"limit": 0,
"offset": 0,
"count": 0,
"manufacturing_order": [{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}
]
}

Post Manufacturing Order

Authorizations:

APIKey

Request Body schema: application/json

reference_id required	string
warehouse_id	integer
manufacturer_notes	string or null
internal_notes	string or null
	Array of objects (Add a Manufacturing Order Line) [ items ]
tax_amount	number >= 0
shipping_amount	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"sku": "string",
"requested_quantity": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"unit_cost": 0,
"labor_unit_cost": 0
}
],
"tax_amount": 0,
"shipping_amount": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Put Manufacturing Order

Authorizations:

APIKey

Request Body schema: application/json

status	string Enum: "initiated" "active" "finished" "cancelled"
manufacturer_notes	string
internal_notes	string
warehouse_id	integer
tax_amount	number >= 0
shipping_amount	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"status": "initiated",
"manufacturer_notes": "string",
"internal_notes": "string",
"warehouse_id": 0,
"tax_amount": 0,
"shipping_amount": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Get Manufacturing Order Counts

Authorizations:

APIKey

query Parameters

group_by

Array of strings

Items Enum: "warehouse_id" "status"

Responses

Delete Manufacturing Order Tag

Authorizations:

APIKey

Responses

Get Manufacturing Order Tag

Authorizations:

APIKey

query Parameters

limit	integer [ 1 .. 100 ] Default: 10
offset	integer Default: 0
id	Array of integers[ items ]

Responses

Response samples

Content type

application/json

{"count": 0,
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"limit": 10,
"offset": 0
}

Post Manufacturing Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Manufacturing Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Delete Manufacturing Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Get Manufacturing Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Post Manufacturing Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Manufacturing Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Get Manufacturing Order

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Post Manufacturing Order

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

reference_id required	string
warehouse_id	integer
manufacturer_notes	string or null
internal_notes	string or null
	Array of objects (Add a Manufacturing Order Line) [ items ]
tax_amount	number >= 0
shipping_amount	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"sku": "string",
"requested_quantity": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"unit_cost": 0,
"labor_unit_cost": 0
}
],
"tax_amount": 0,
"shipping_amount": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Put Manufacturing Order

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

status	string Enum: "initiated" "active" "finished" "cancelled"
manufacturer_notes	string
internal_notes	string
warehouse_id	integer
tax_amount	number >= 0
shipping_amount	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"status": "initiated",
"manufacturer_notes": "string",
"internal_notes": "string",
"warehouse_id": 0,
"tax_amount": 0,
"shipping_amount": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Get Manufacturing Order Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 35,
"limit": 1,
"offset": 0,
"comment": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Manufacturing Order Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}

Delete Manufacturing Order Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Post Manufacturing Order Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

sku required	string
requested_quantity	number
manufacturer_notes	string or null
internal_notes	string or null
unit_cost	number >= 0
labor_unit_cost	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"requested_quantity": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"unit_cost": 0,
"labor_unit_cost": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Put Manufacturing Order Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

requested_quantity	number
finished_quantity	number
manufacturer_notes	string or null
internal_notes	string or null
unit_cost	number >= 0
labor_unit_cost	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"requested_quantity": 0,
"finished_quantity": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"unit_cost": 0,
"labor_unit_cost": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Delete Manufacturing Order Line

Authorizations:

APIKey

path Parameters

reference_id required	string
manufacturing_order_line_id required	integer

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Post Manufacturing Order Line

Authorizations:

APIKey

path Parameters

reference_id required	string
manufacturing_order_line_id required	integer

Request Body schema: application/json

sku required	string
requested_quantity	number
manufacturer_notes	string or null
internal_notes	string or null
unit_cost	number >= 0
labor_unit_cost	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"requested_quantity": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"unit_cost": 0,
"labor_unit_cost": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Put Manufacturing Order Line

Authorizations:

APIKey

path Parameters

reference_id required	string
manufacturing_order_line_id required	integer

Request Body schema: application/json

requested_quantity	number
finished_quantity	number
manufacturer_notes	string or null
internal_notes	string or null
unit_cost	number >= 0
labor_unit_cost	number >= 0

Responses

Request samples

Payload

Content type

application/json

{"requested_quantity": 0,
"finished_quantity": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"unit_cost": 0,
"labor_unit_cost": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Post Manufacturing Order Line Finish

Authorizations:

APIKey

path Parameters

reference_id required	string
manufacturing_order_line_id required	integer

Request Body schema: application/json

amount

required

integer

Responses

Request samples

Payload

Content type

application/json

{"amount": 0
}

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Delete Manufacturing Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

reference_id required	string
name required	string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Post Manufacturing Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

reference_id required	string
name required	string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"status": "string",
"warehouse_id": 0,
"manufacturer_notes": "string",
"internal_notes": "string",
"lines": [{"_link": "string",
"id": 0,
"sku": "string",
"bom_sku": "string",
"manufacturer_notes": "string",
"internal_notes": "string",
"requested_quantity": 0,
"finished_quantity": 0,
"created_date": "string",
"updated_date": "string"
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"updated_date": "string"
}

Order

Get Label

Authorizations:

APIKey

query Parameters

o	string The Order number. To retrieve multiple labels, pass in multiple 'o' params
ro	string The reference id for a Return Order. To retrieve multiple labels, pass in multiple 'ro' params.
pdf_type	string Enum: "additional_docs" "canada_pdf" "multi_page" "single_page"
size	string Enum: "desktop" "thermal" "custom"
page_width	string
page_height	string
page_top_margin	string
page_left_margin	string
label_width	string
label_height	string
label_rotation	string Enum: "0" "90" "180" "270"
return	boolean

Responses

Get Label

Authorizations:

APIKey

path Parameters

label_data_id

required

integer

Responses

Get Multi Order

Authorizations:

APIKey

query Parameters

required

Array of strings [ 1 .. 100 ] items

Responses

Response samples

Content type

application/json

{"count": 0,
"order": [{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}
]
}

Get Order

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
order_number	Array of strings
barcode	string
status	Array of strings Items Enum: "all" "awaiting_fulfillment" "on_hold" "shipped" "cancelled" "dropshipment_requested" "merged" "archived"
allocation_status	Array of strings Items Enum: "unallocated" "could_not_allocate" "partial" "allocated" "overallocated"
allocatable	boolean
sales_channel	Array of integers[ items ]
cart_order_id	string
warehouse_id	Array of integers[ items ]
supplier	Array of integers[ items ]
shipper	Array of integers[ items ]
tag	Array of strings
untagged	boolean
printed	boolean Deprecated
label_printed	boolean
packing_list_printed	boolean
sku	Array of strings
has_similar_open_addresses	boolean
similar_address_to	string
ship_to_is_bill_to	boolean
ship_to_country	Array of strings
ship_to_status	string Enum: "error" "unvalidated" "warning" "validated"
created_after	string <date-time>
created_before	string <date-time>
created_interval_type	string
created_interval_amount	number
created_interval_trunc	boolean
updated_after	string <date-time>
updated_before	string <date-time>
updated_interval_type	string
updated_interval_amount	number
updated_interval_trunc	boolean
order_placed_after	string <date-time>
order_placed_before	string <date-time>
order_placed_interval_type	string
order_placed_interval_amount	number
order_placed_interval_trunc	boolean
shipped_after	string <date-time>
shipped_before	string <date-time>
shipped_interval_type	string
shipped_interval_amount	number
shipped_interval_trunc	boolean
dropshipped_after	string <date-time>
dropshipped_before	string <date-time>
dropshipped_interval_type	string
dropshipped_interval_amount	number
dropshipped_interval_trunc	boolean
deliver_by_after	string <date-time>
deliver_by_before	string <date-time>
deliver_by_interval_type	string
deliver_by_interval_amount	number
deliver_by_interval_trunc	boolean
ship_by_after	string <date-time>
ship_by_before	string <date-time>
ship_by_interval_type	string
ship_by_interval_amount	number
ship_by_interval_trunc	boolean
cancelled_after	string <date-time>
cancelled_before	string <date-time>
cancelled_interval_type	string
cancelled_interval_amount	number
cancelled_interval_trunc	boolean
line_count_gte	number
line_count_lte	number
timezone	string
sort	string Enum: "batch" "-batch" "order_placed_date" "-order_placed_date" "grand_total" "-grand_total" "order_number" "-order_number" "created_date" "-created_date" "updated_date" "-updated_date" "ship_date" "-ship_date" "dropship_date" "-dropship_date" "deliver_by_date" "-deliver_by_date" "ship_by_date" "-ship_by_date" "cancelled_date" "-cancelled_date" "shipping_method" "-shipping_method" "status" "-status" "billing_address_name" "-billing_address_name" "billing_address_zip" "-billing_address_zip" "shipping_address_name" "-shipping_address_name" "shipping_address_zip" "-shipping_address_zip" "sku" "-sku"
search	string
tag_filter_by	string Enum: "or" "and" "only"
exclude_tags	Array of strings
unready	boolean
batch_reference_id	Array of strings
has_revision	boolean
carrier_error	boolean
in_batch	boolean
batch_error	boolean

Responses

Response samples

Content type

application/json

{"limit": 0,
"offset": 0,
"count": 0,
"order": [{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}
]
}

Head Order

Authorizations:

APIKey

Responses

Post Order

Authorizations:

APIKey

Request Body schema: application/json

cart	integer
shipping_address	string
billing_address	string
alternate_ship_from_address	string
order_id	string [ 1 .. 255 ] characters
order_date	string <date-time>
cart_order_id	string <= 255 characters
warehouse_id	integer
status	string
cart_shipment_id	string <= 255 characters
shipping_type	string <= 255 characters
deliver_by_date	string <date-time>
ship_by_date	string <date-time>
additional_cart_info	string
notes_from_customer	string
internal_notes	string
credit_card_issuer	string <= 255 characters
product_amount	number
shipping_amount	number
tax_amount	number
discount_amount	number
grand_total	number
lines	Array of strings
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"cart": 0,
"shipping_address": "string",
"billing_address": "string",
"alternate_ship_from_address": "string",
"order_id": "string",
"order_date": "2019-08-24T14:15:22Z",
"cart_order_id": "string",
"warehouse_id": 0,
"status": "string",
"cart_shipment_id": "string",
"shipping_type": "string",
"deliver_by_date": "2019-08-24T14:15:22Z",
"ship_by_date": "2019-08-24T14:15:22Z",
"additional_cart_info": "string",
"notes_from_customer": "string",
"internal_notes": "string",
"credit_card_issuer": "string",
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"discount_amount": 0,
"grand_total": 0,
"lines": ["string"
],
"tags": ["string"
]
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order

Authorizations:

APIKey

Request Body schema: application/json

notes_from_customer	string Customer notes
internal_notes	string Staff notes
batch_reference_id	string Batch ID
ship_by_date	null or string <date-time> The date the order must be shipped by
deliver_by_date	null or string <date-time> The date the order must be delivered by

Responses

Request samples

Payload

Content type

application/json

{"notes_from_customer": "string",
"internal_notes": "string",
"batch_reference_id": "string",
"ship_by_date": null,
"deliver_by_date": null
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Order Charge

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"charges": [{"user": "string",
"stripe_charge_id": "string",
"description": "string",
"amount": 0,
"currency": "string",
"created": "string"
}
]
}

Post Order Charge

Authorizations:

APIKey

Request Body schema: application/json

integration_id required	integer
order_numbers required	Array of strings non-empty
amount required	integer >= 50 A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge 100 yen, a zero-decimal currency) representing how much to charge the card
currency required	string 3 characters 3 letter ISO code for currency
source required	string Stripe token obtained via Stripe.js
description required	string

Responses

Request samples

Payload

Content type

application/json

{"integration_id": 0,
"order_numbers": ["string"
],
"amount": 50,
"currency": "str",
"source": "string",
"description": "string"
}

Response samples

Content type

application/json

{"user": "string",
"stripe_charge_id": "string",
"description": "string",
"amount": 0,
"currency": "string",
"created": "string"
}

Get Order Charge

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"charges": [{"user": "string",
"stripe_charge_id": "string",
"description": "string",
"amount": 0,
"currency": "string",
"created": "string"
}
]
}

Post Order Charge

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

integration_id required	integer
order_numbers required	Array of strings non-empty
amount required	integer >= 50 A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge 100 yen, a zero-decimal currency) representing how much to charge the card
currency required	string 3 characters 3 letter ISO code for currency
source required	string Stripe token obtained via Stripe.js
description required	string

Responses

Request samples

Payload

Content type

application/json

{"integration_id": 0,
"order_numbers": ["string"
],
"amount": 50,
"currency": "str",
"source": "string",
"description": "string"
}

Response samples

Content type

application/json

{"user": "string",
"stripe_charge_id": "string",
"description": "string",
"amount": 0,
"currency": "string",
"created": "string"
}

Get Order Counts

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
order_number	Array of strings
barcode	string
status	Array of strings Items Enum: "all" "awaiting_fulfillment" "on_hold" "shipped" "cancelled" "dropshipment_requested" "merged" "archived"
allocation_status	Array of strings Items Enum: "unallocated" "could_not_allocate" "partial" "allocated" "overallocated"
allocatable	boolean
sales_channel	Array of integers[ items ]
cart_order_id	string
warehouse_id	Array of integers[ items ]
supplier	Array of integers[ items ]
shipper	Array of integers[ items ]
tag	Array of strings
untagged	boolean
printed	boolean Deprecated
label_printed	boolean
packing_list_printed	boolean
sku	Array of strings
has_similar_open_addresses	boolean
similar_address_to	string
ship_to_is_bill_to	boolean
ship_to_country	Array of strings
ship_to_status	string Enum: "error" "unvalidated" "warning" "validated"
created_after	string <date-time>
created_before	string <date-time>
created_interval_type	string
created_interval_amount	number
created_interval_trunc	boolean
updated_after	string <date-time>
updated_before	string <date-time>
updated_interval_type	string
updated_interval_amount	number
updated_interval_trunc	boolean
order_placed_after	string <date-time>
order_placed_before	string <date-time>
order_placed_interval_type	string
order_placed_interval_amount	number
order_placed_interval_trunc	boolean
shipped_after	string <date-time>
shipped_before	string <date-time>
shipped_interval_type	string
shipped_interval_amount	number
shipped_interval_trunc	boolean
dropshipped_after	string <date-time>
dropshipped_before	string <date-time>
dropshipped_interval_type	string
dropshipped_interval_amount	number
dropshipped_interval_trunc	boolean
deliver_by_after	string <date-time>
deliver_by_before	string <date-time>
deliver_by_interval_type	string
deliver_by_interval_amount	number
deliver_by_interval_trunc	boolean
ship_by_after	string <date-time>
ship_by_before	string <date-time>
ship_by_interval_type	string
ship_by_interval_amount	number
ship_by_interval_trunc	boolean
cancelled_after	string <date-time>
cancelled_before	string <date-time>
cancelled_interval_type	string
cancelled_interval_amount	number
cancelled_interval_trunc	boolean
line_count_gte	number
line_count_lte	number
timezone	string
sort	string Enum: "batch" "-batch" "order_placed_date" "-order_placed_date" "grand_total" "-grand_total" "order_number" "-order_number" "created_date" "-created_date" "updated_date" "-updated_date" "ship_date" "-ship_date" "dropship_date" "-dropship_date" "deliver_by_date" "-deliver_by_date" "ship_by_date" "-ship_by_date" "cancelled_date" "-cancelled_date" "shipping_method" "-shipping_method" "status" "-status" "billing_address_name" "-billing_address_name" "billing_address_zip" "-billing_address_zip" "shipping_address_name" "-shipping_address_name" "shipping_address_zip" "-shipping_address_zip" "sku" "-sku"
search	string
tag_filter_by	string Enum: "or" "and" "only"
exclude_tags	Array of strings
unready	boolean
batch_reference_id	Array of strings
has_revision	boolean
carrier_error	boolean
in_batch	boolean
batch_error	boolean

Responses

Response samples

Content type

application/json

{"all": 0,
"awaiting_fulfillment": 0,
"on_hold": 0,
"cancelled": 0,
"dropshipment_requested": 0,
"unprinted_shipped": 0,
"shipped": 0
}

Post Order Merge

Merges orders. The primary order will survive, and information from the other orders will be folded into it.

Authorizations:

APIKey

Request Body schema: application/json

merge_into required	string
merge_from required	Array of strings non-empty

Responses

Request samples

Payload

Content type

application/json

{"merge_into": "string",
"merge_from": ["string"
]
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Parent Order

Authorizations:

APIKey

path Parameters

parent_order_number

required

string

Responses

Response samples

Content type

application/json

{"order_number": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"lines": [{"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"order_line_product_name": "string",
"product_link": "string",
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string"
}
],
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"child_order_numbers": ["string"
],
"ready": true
}

Delete Order Tag

Authorizations:

APIKey

Responses

Get Order Tag

Authorizations:

APIKey

query Parameters

limit	integer [ 1 .. 100 ] Default: 10
offset	integer Default: 0
id	Array of integers[ items ]

Responses

Response samples

Content type

application/json

{"count": 0,
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"limit": 10,
"offset": 0
}

Post Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Delete Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Get Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Post Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Get Order

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Head Order

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

cart	integer
shipping_address	string
billing_address	string
alternate_ship_from_address	string
order_id	string [ 1 .. 255 ] characters
order_date	string <date-time>
cart_order_id	string <= 255 characters
warehouse_id	integer
status	string
cart_shipment_id	string <= 255 characters
shipping_type	string <= 255 characters
deliver_by_date	string <date-time>
ship_by_date	string <date-time>
additional_cart_info	string
notes_from_customer	string
internal_notes	string
credit_card_issuer	string <= 255 characters
product_amount	number
shipping_amount	number
tax_amount	number
discount_amount	number
grand_total	number
lines	Array of strings
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"cart": 0,
"shipping_address": "string",
"billing_address": "string",
"alternate_ship_from_address": "string",
"order_id": "string",
"order_date": "2019-08-24T14:15:22Z",
"cart_order_id": "string",
"warehouse_id": 0,
"status": "string",
"cart_shipment_id": "string",
"shipping_type": "string",
"deliver_by_date": "2019-08-24T14:15:22Z",
"ship_by_date": "2019-08-24T14:15:22Z",
"additional_cart_info": "string",
"notes_from_customer": "string",
"internal_notes": "string",
"credit_card_issuer": "string",
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"discount_amount": 0,
"grand_total": 0,
"lines": ["string"
],
"tags": ["string"
]
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

notes_from_customer	string Customer notes
internal_notes	string Staff notes
batch_reference_id	string Batch ID
ship_by_date	null or string <date-time> The date the order must be shipped by
deliver_by_date	null or string <date-time> The date the order must be delivered by

Responses

Request samples

Payload

Content type

application/json

{"notes_from_customer": "string",
"internal_notes": "string",
"batch_reference_id": "string",
"ship_by_date": null,
"deliver_by_date": null
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order Alternate Ship From Address

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

name	string or null
company	string or null
street1	string or null
street2	string or null
city	string or null
state	string or null
zip	string or null
country	string or null
email	string or null
email_cc	string or null
email_bcc	string or null
phone	string or null
validate	boolean
set_revision_lock	boolean
	object (Validation status of an Address)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"validate": true,
"set_revision_lock": true,
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}

Response samples

Content type

application/json

{"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}

Post Order Attempt To Allocate

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

force_comment

boolean

Responses

Request samples

Payload

Content type

application/json

{"force_comment": true
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order Billing Address

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

name	string or null
company	string or null
street1	string or null
street2	string or null
city	string or null
state	string or null
zip	string or null
country	string or null
email	string or null
email_cc	string or null
email_bcc	string or null
phone	string or null
validate	boolean
set_revision_lock	boolean
	object (Validation status of an Address)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"validate": true,
"set_revision_lock": true,
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}

Response samples

Content type

application/json

{"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}

Post Order Cancel

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Order Comment

Authorizations:

APIKey

path Parameters

order_number

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 35,
"limit": 1,
"offset": 0,
"comment": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Order Comment

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}

Post Order Deallocate

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Delete Order Document

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order Document

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Delete Order Document

Authorizations:

APIKey

path Parameters

order_number required	string
document_id required	integer

Responses

Post Order Document

Authorizations:

APIKey

path Parameters

order_number required	string
document_id required	integer

Responses

Delete Order Dropship

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Order Dropship

Authorizations:

APIKey

path Parameters

order_number

required

string

query Parameters

supplier_id required	integer
shipping_method	string or null
shipping_account	string
shipping_carrier	string
instructions	string
show_images_email	boolean Default: false
show_images_packing_list	boolean Default: false
show_price	boolean Default: false
show_ship_to_email	boolean Default: false
show_customer_notes_email	boolean Default: true
include_digital_products	boolean Default: true
packing_list_id	integer
override_shipping_mappings	boolean Default: false

Responses

Post Order Dropship

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

supplier_id required	integer
shipping_method	string or null
shipping_account	string
shipping_carrier	string
instructions	string
show_images_email	boolean Default: false
show_images_packing_list	boolean Default: false
show_price	boolean Default: false
show_ship_to_email	boolean Default: false
show_customer_notes_email	boolean Default: true
include_digital_products	boolean Default: true
packing_list_id	integer
override_shipping_mappings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"supplier_id": 0,
"shipping_method": "string",
"shipping_account": "string",
"shipping_carrier": "string",
"instructions": "string",
"show_images_email": false,
"show_images_packing_list": false,
"show_price": false,
"show_ship_to_email": false,
"show_customer_notes_email": true,
"include_digital_products": true,
"packing_list_id": 0,
"override_shipping_mappings": false
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order F B A Received

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

success required	boolean
audit	string or null
tracking_number	string or null
carrier_name	string or null
ship_date	string or null <date-time>
estimated_delivery_date	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"success": true,
"audit": "string",
"tracking_number": "string",
"carrier_name": "string",
"ship_date": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Order F B A Sent

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

success required	boolean
audit required	string or null

Responses

Request samples

Payload

Content type

application/json

{"success": true,
"audit": "string"
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order Financial

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

credit_card_issuer	string or null
discount_amount	number or null Not calculated
product_amount	number or null Not calculated
shipping_amount	number or null Not calculated
tax_amount	number or null Not calculated
grand_total	number or null Not calculated

Responses

Request samples

Payload

Content type

application/json

{"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
}

Response samples

Content type

application/json

{"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
}

Post Order Hold

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Order Label Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Patch Order Label Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

attach_customs_info	boolean
can_have_delivery_confirmation	boolean
certificate_origin	boolean
customs_info	array
etd_service	boolean
include_insurance	boolean
insured_value	string or number
invoice_number	string
packages	array
packaging_weight	number
packing_list_id	integer
pickup_date	string <date-time>
recipient_address_is_residential	boolean
reference_number	string
ship_date	string <date-time>
shipper_id	integer
shipper_ids	Array of integers[ items ]
	object (address)
amazon__delivery_confirmation	string
amazon_shipper__shipping_purpose	string
canada_post__reason_for_export	string
canada_post__nondelivery_option	string
dhl__duty_payment_type	string
dhl__reason_for_export	string
fedex__duties_payment_type	string
fedex__smart_post_hub	string
ups__usps_endorsement	string
ups__duties_payment_type	string
ups__package_bill_type	string
is_mail_innovations	boolean

Responses

Request samples

Payload

Content type

application/json

{"attach_customs_info": true,
"can_have_delivery_confirmation": true,
"certificate_origin": true,
"customs_info": [ ],
"etd_service": true,
"include_insurance": true,
"insured_value": "string",
"invoice_number": "string",
"packages": [ ],
"packaging_weight": 0,
"packing_list_id": 0,
"pickup_date": "2019-08-24T14:15:22Z",
"recipient_address_is_residential": true,
"reference_number": "string",
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipper_ids": [0
],
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"amazon__delivery_confirmation": "string",
"amazon_shipper__shipping_purpose": "string",
"canada_post__reason_for_export": "string",
"canada_post__nondelivery_option": "string",
"dhl__duty_payment_type": "string",
"dhl__reason_for_export": "string",
"fedex__duties_payment_type": "string",
"fedex__smart_post_hub": "string",
"ups__usps_endorsement": "string",
"ups__duties_payment_type": "string",
"ups__package_bill_type": "string",
"is_mail_innovations": true
}

Delete Order Line

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order Line

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

quantity	integer Default: 1
item_price	number
total_price	number
discount_amount	number
product_name	string
product_serial_numbers	Array of strings
sku required	string
details	string
sales_channel_location_id	integer or null
cart_orderitem_id	string
cart_order_id	string
cart_shipment_id	string

Responses

Request samples

Payload

Content type

application/json

{"quantity": 1,
"item_price": 0,
"total_price": 0,
"discount_amount": 0,
"product_name": "string",
"product_serial_numbers": ["string"
],
"sku": "string",
"details": "string",
"sales_channel_location_id": 0,
"cart_orderitem_id": "string",
"cart_order_id": "string",
"cart_shipment_id": "string"
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order Line

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

quantity	integer
item_price	number
total_price	number
discount_amount	number
details	string or null
product_serial_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"quantity": 0,
"item_price": 0,
"total_price": 0,
"discount_amount": 0,
"details": "string",
"product_serial_numbers": ["string"
]
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Delete Order Line

Authorizations:

APIKey

path Parameters

order_number required	string
order_line_id required	string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order Line

Authorizations:

APIKey

path Parameters

order_number required	string
order_line_id required	string

Request Body schema: application/json

quantity	integer Default: 1
item_price	number
total_price	number
discount_amount	number
product_name	string
product_serial_numbers	Array of strings
sku required	string
details	string
sales_channel_location_id	integer or null
cart_orderitem_id	string
cart_order_id	string
cart_shipment_id	string

Responses

Request samples

Payload

Content type

application/json

{"quantity": 1,
"item_price": 0,
"total_price": 0,
"discount_amount": 0,
"product_name": "string",
"product_serial_numbers": ["string"
],
"sku": "string",
"details": "string",
"sales_channel_location_id": 0,
"cart_orderitem_id": "string",
"cart_order_id": "string",
"cart_shipment_id": "string"
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order Line

Authorizations:

APIKey

path Parameters

order_number required	string
order_line_id required	string

Request Body schema: application/json

quantity	integer
item_price	number
total_price	number
discount_amount	number
details	string or null
product_serial_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"quantity": 0,
"item_price": 0,
"total_price": 0,
"discount_amount": 0,
"details": "string",
"product_serial_numbers": ["string"
]
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Order Linked Orders

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order Mark As Dropshipped

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

supplier_id required	integer
shipping_method	string or null
shipping_account	string
shipping_carrier	string
instructions	string
show_images_email	boolean Default: false
show_images_packing_list	boolean Default: false
show_price	boolean Default: false
show_ship_to_email	boolean Default: false
show_customer_notes_email	boolean Default: true
include_digital_products	boolean Default: true
packing_list_id	integer
override_shipping_mappings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"supplier_id": 0,
"shipping_method": "string",
"shipping_account": "string",
"shipping_carrier": "string",
"instructions": "string",
"show_images_email": false,
"show_images_packing_list": false,
"show_price": false,
"show_ship_to_email": false,
"show_customer_notes_email": true,
"include_digital_products": true,
"packing_list_id": 0,
"override_shipping_mappings": false
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order Mark As Printed

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

Array

string

Enum: "label" "packing_list"

Responses

Request samples

Payload

Content type

application/json

["label"
]

Post Order Mark As Shipped

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order Notified Cart

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

success required	boolean
message required	string
retry	boolean
retry_after_date	null or string

Responses

Request samples

Payload

Content type

application/json

{"success": true,
"message": "string",
"retry": true,
"retry_after_date": null
}

Delete Order Printed

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

Array

string

Enum: "label" "packing_list"

Responses

Request samples

Payload

Content type

application/json

["label"
]

Post Order Printed

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

Array

string

Enum: "label" "packing_list"

Responses

Request samples

Payload

Content type

application/json

["label"
]

Post Order Process Dropshipments

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order Render Label

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

property name*

any

Responses

Request samples

Payload

Content type

application/json

{ }

Post Order Render Packing List

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

utc_offset required	string
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"utc_offset": "string"
}

Get Order Return Label Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Patch Order Return Label Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

attach_customs_info	boolean
can_have_delivery_confirmation	boolean
certificate_origin	boolean
customs_info	array
etd_service	boolean
include_insurance	boolean
insured_value	string or number
invoice_number	string
packages	array
packaging_weight	number
packing_list_id	integer
pickup_date	string <date-time>
recipient_address_is_residential	boolean
reference_number	string
ship_date	string <date-time>
shipper_id	integer
shipper_ids	Array of integers[ items ]
	object (address)
amazon__delivery_confirmation	string
amazon_shipper__shipping_purpose	string
canada_post__reason_for_export	string
canada_post__nondelivery_option	string
dhl__duty_payment_type	string
dhl__reason_for_export	string
fedex__duties_payment_type	string
fedex__smart_post_hub	string
ups__usps_endorsement	string
ups__duties_payment_type	string
ups__package_bill_type	string
is_mail_innovations	boolean

Responses

Request samples

Payload

Content type

application/json

{"attach_customs_info": true,
"can_have_delivery_confirmation": true,
"certificate_origin": true,
"customs_info": [ ],
"etd_service": true,
"include_insurance": true,
"insured_value": "string",
"invoice_number": "string",
"packages": [ ],
"packaging_weight": 0,
"packing_list_id": 0,
"pickup_date": "2019-08-24T14:15:22Z",
"recipient_address_is_residential": true,
"reference_number": "string",
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipper_ids": [0
],
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"amazon__delivery_confirmation": "string",
"amazon_shipper__shipping_purpose": "string",
"canada_post__reason_for_export": "string",
"canada_post__nondelivery_option": "string",
"dhl__duty_payment_type": "string",
"dhl__reason_for_export": "string",
"fedex__duties_payment_type": "string",
"fedex__smart_post_hub": "string",
"ups__usps_endorsement": "string",
"ups__duties_payment_type": "string",
"ups__package_bill_type": "string",
"is_mail_innovations": true
}

Post Order Return Label Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Delete Order Return Preset

Authorizations:

APIKey

path Parameters

order_number required	string
preset_id required	integer

Responses

Response samples

Content type

application/json

{"presets": [0
]
}

Post Order Return Preset

Authorizations:

APIKey

path Parameters

order_number required	string
preset_id required	integer

Responses

Response samples

Content type

application/json

{"presets": [0
]
}

Delete Order Revision

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Get Order Revision

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order Revision

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

apply_lines_changed	Array of integers or arrays[ items ]
apply_lines_added	Array of strings[ items ]
apply_lines_removed	Array of integers[ items ]
apply_shipping_address	Array of strings
recalculate_financials	boolean

Responses

Request samples

Payload

Content type

application/json

{"apply_lines_changed": [0
],
"apply_lines_added": ["string"
],
"apply_lines_removed": [0
],
"apply_shipping_address": ["string"
],
"recalculate_financials": true
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Delete Order Revision

Authorizations:

APIKey

path Parameters

order_number required	string
revision_id required	integer

Responses

Get Order Revision

Authorizations:

APIKey

path Parameters

order_number required	string
revision_id required	integer

Responses

Post Order Revision

Authorizations:

APIKey

path Parameters

order_number required	string
revision_id required	integer

Request Body schema: application/json

apply_lines_changed	Array of integers or arrays[ items ]
apply_lines_added	Array of strings[ items ]
apply_lines_removed	Array of integers[ items ]
apply_shipping_address	Array of strings
recalculate_financials	boolean

Responses

Request samples

Payload

Content type

application/json

{"apply_lines_changed": [0
],
"apply_lines_added": ["string"
],
"apply_lines_removed": [0
],
"apply_shipping_address": ["string"
],
"recalculate_financials": true
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Order Send Invoice

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order Send Invoice

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Get Order Shipment

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"shipment_id": 0
}

Delete Order Shipment Preset

Authorizations:

APIKey

path Parameters

order_number required	string
preset_id required	integer

Responses

Response samples

Content type

application/json

{"presets": [0
]
}

Post Order Shipment Preset

Authorizations:

APIKey

path Parameters

order_number required	string
preset_id required	integer

Responses

Response samples

Content type

application/json

{"presets": [0
]
}

Put Order Shipping Address

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

name	string or null
company	string or null
street1	string or null
street2	string or null
city	string or null
state	string or null
zip	string or null
country	string or null
email	string or null
email_cc	string or null
email_bcc	string or null
phone	string or null
validate	boolean
set_revision_lock	boolean
	object (Validation status of an Address)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"validate": true,
"set_revision_lock": true,
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}

Response samples

Content type

application/json

{"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
}

Delete Order Shipping Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

notify_cart

boolean

Default: false

A boolean value designating whether or not to notify the sales channel about the cancellation

Responses

Request samples

Payload

Content type

application/json

{"notify_cart": false
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order Shipping Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

tracking_number required	string
package_tracking	string
cost	number
ship_date required	string <date-time>
display_shipping_method	string
shipping_cost	number
shipping_method	string
carrier_name required	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
notify_cart	boolean Default: false
tracking_url	string
zone	string or null

Responses

Request samples

Payload

Content type

application/json

{"tracking_number": "string",
"package_tracking": "string",
"cost": 0,
"ship_date": "2019-08-24T14:15:22Z",
"display_shipping_method": "string",
"shipping_cost": 0,
"shipping_method": "string",
"carrier_name": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"notify_cart": false,
"tracking_url": "string",
"zone": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Put Order Shipping Info

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

tracking_number required	string
package_tracking	string
cost	number
ship_date required	string <date-time>
display_shipping_method	string
shipping_cost	number
shipping_method	string
carrier_name required	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
notify_cart	boolean Default: false
tracking_url	string
zone	string or null

Responses

Request samples

Payload

Content type

application/json

{"tracking_number": "string",
"package_tracking": "string",
"cost": 0,
"ship_date": "2019-08-24T14:15:22Z",
"display_shipping_method": "string",
"shipping_cost": 0,
"shipping_method": "string",
"carrier_name": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"notify_cart": false,
"tracking_url": "string",
"zone": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Order Split

Creates n orders, derived from the given order. The original order will be linked to the new orders

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

required

Array of objects >= 2 items [ items ]

Responses

Request samples

Payload

Content type

application/json

{"split_orders": [{"lines": [{"line_id": 0,
"quantity": 0
}
]
},
{"lines": [{"line_id": 0,
"quantity": 0
}
]
}
]
}

Response samples

Content type

application/json

["string",
"string"
]

Delete Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

order_number required	string
name required	string

Responses

Response samples

Content type

application/json

[{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
]

Post Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

order_number required	string
name required	string

Responses

Response samples

Content type

application/json

[{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
]

Delete Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

order_number required	string
name required	string

Responses

Response samples

Content type

application/json

[{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
]

Post Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

order_number required	string
name required	string

Responses

Response samples

Content type

application/json

[{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
]

Post Order Uncancel

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order Unhold

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Put Order Warehouse

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

warehouse_id required	integer
skip_cache	boolean Default: false Updates the order but does not add it to the Elasticsearch cache. Used internally during initial order processing. This will probably go away in the future.

Responses

Request samples

Payload

Content type

application/json

{"warehouse_id": 0,
"skip_cache": false
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Order Label V3

Delete Order Label

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

return	boolean Default: false A boolean value to delete a return label or a forward shipping label
notify_cart	boolean Default: false A boolean value designating whether or not to notify the sales channel about the cancellation

Responses

Request samples

Payload

Content type

application/json

{"return": false,
"notify_cart": false
}

Response samples

Content type

application/json

{"id": 0,
"order_number": "string",
"barcode": "string",
"order_placed_date": "string",
"created_date": "string",
"updated_date": "string",
"cancelled_date": "string",
"obscured_date": "string",
"status": "string",
"shippability": "string",
"shipping_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"billing_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"alternate_ship_from_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"label_infos": [0
],
"lines": [{"link": "string",
"id": 0,
"quantity": 0,
"item_price": 0,
"supplier_price": 0,
"sku": "string",
"product_name": "string",
"product_is_kit_parent": true,
"product_serial_numbers": ["string"
],
"order_line_product_name": "string",
"product_link": "string",
"product_category": "string",
"cart_order_id": "string",
"cart_orderitem_id": "string",
"cart_shipment_id": "string",
"cogs": 0,
"shippability": {"shippability": "string",
"supplier_id": 0,
"is_dropship": true
},
"details": "string",
"upc": "string",
"sales_channel_location_id": 0,
"is_allocated": true
}
],
"weight": 0,
"notes_from_customer": "string",
"internal_notes": "string",
"requested_shipping_method": "string",
"deliver_by_date": "string",
"ship_by_date": "string",
"sales_channel": {"id": 0,
"link": "string"
},
"warehouse": {"id": 0,
"link": "string"
},
"shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"return_shipping_info": {"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
},
"dropshipping_info": {"supplier": {"id": 0,
"link": "string"
},
"requested_date": "2019-08-24T14:15:22Z",
"show_ship_to_email": true,
"show_price": true,
"show_customer_notes_email": true,
"include_digital_products": true,
"requested_shipping_method": "string",
"requested_shipping_carrier": "string",
"requested_shipping_account": "string",
"instructions": "string"
},
"comments": [{"date": "string",
"text": "string",
"user": "string"
}
],
"tags": [{"color": "string",
"text": "string",
"name": "string",
"link": "string",
"id": 0
}
],
"financial": {"credit_card_issuer": "string",
"discount_amount": 0,
"product_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"grand_total": 0
},
"link": "string",
"additional_cart_info": {"is_prime": true
},
"is_order_parent": true,
"parent_order_number": "string",
"sibling_order_numbers": ["string"
],
"audit_label": [{ }
],
"return_order_reference_ids": ["string"
],
"similar_open_addresses_count": 0,
"allocation_status": "string",
"batch_reference_id": "string",
"batch": { },
"has_revision": true,
"revision_locked_fields": ["string"
],
"packing_list_print_date": "string"
}

Post Order Label

create label for an order based on label_info.config

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order Label Amazon

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id required	integer
delivery_confirmation required	string Enum: "DeliveryConfirmationWithAdultSignature" "DeliveryConfirmationWithoutSignature" "DeliveryConfirmationWithSignature" "NoPreference" "NoTracking"
weight	number Weight in ounces
length	number Length in inches
width	number Width in inches
height	number Height in inches
box_shape	string
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
shipping_method required	string
ship_date	string <date-time>
arrive_by_date	string <date-time>
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
carrier_pickup	boolean
	object (v1_address) The ship_from address is used as the source of the shipment label. This can be a warehouse or a supplier address.
insurance_type	string Value: "amazon"
insured_value	number Default: 0
is_hazmat	boolean Default: false boolean indicator for hazardous materials
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"delivery_confirmation": "DeliveryConfirmationWithAdultSignature",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"box_shape": "string",
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"box_shape": "string"
}
],
"packing_list_id": 0,
"shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"arrive_by_date": "2019-08-24T14:15:22Z",
"notify_bill_to": false,
"notify_ship_to": false,
"carrier_pickup": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"insurance_type": "amazon",
"insured_value": 0,
"is_hazmat": false,
"warehouse_id": 0
}

Post Order Label Amazon Shipper

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
recipient_address_is_residential	boolean
reference_number	string
service_token required	string token returned from Amazon Shipping rate request upon selection of a service type. Conditionally required if `shipment_id` is present.
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipment_id required	string id returned from Amazon Shipping rate request which creates an Amazon Shipping shipment
shipper_id required	integer
is_hazmat	boolean Default: false boolean indicator for hazardous materials unused if shipment_id and service_token are present as shipment has already been created
shipping_method	string Service type for the Amazon shipment. Unused if shipment_id and service_token are present.

Responses

Request samples

Payload

Content type

application/json

{"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"box_shape": "string",
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"recipient_address_is_residential": true,
"reference_number": "string",
"service_token": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipment_id": "string",
"shipper_id": 0,
"is_hazmat": false,
"shipping_method": "string"
}

Post Order Label Australia Post

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

box_shape	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string
insurance_type	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
required	Array of objects <= 200 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
reason_for_export	string
reference_id	string Identifier for a Return Order
reference_number	string Package level reference, not always necessarily a number
return	boolean
service_token	string token for rate type received for a specific shipment, required if shipment_id is included
ship_date	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipment_id	string id of shipment created by easypost
shipper_id required	integer
shipping_method	string Service type: unused if shipment_id and service_token are present.

Responses

Request samples

Payload

Content type

application/json

{"box_shape": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"insurance_type": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"additional_handling": true,
"box_shape": "string",
"height": 0,
"length": 0,
"reference_number": "string",
"reference": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"reason_for_export": "string",
"reference_id": "string",
"reference_number": "string",
"return": true,
"service_token": "string",
"ship_date": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipment_id": "string",
"shipper_id": 0,
"shipping_method": "string"
}

Post Order Label Canada Post

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_type	string unused with maryann carrier implementation
shipper_id required	integer
shipping_method required	string Domestic - [DOM.RP - Regular Parcel, DOM.EP - Expedited Parcel, DOM.XP - Xpresspost, DOM.PC - Priority], USA - [USA.PW.ENV - Priority Worldwide Envelope USA, USA.PW.PAK - Priority Worldwide pak USA, USA.PW.PARCEL - Priority Worldwide Parcel USA, USA.XP - Xpresspost USA, USA.EP - Expedited Parcel USA, USA.SP.AIR - Small Packet USA Air, USA.TP - Tracked Packet - USA], International - [INT.IP.AIR - International Parcel Air, INT.IP.SURF International Parcel Surface, INT.PW.ENV - Priority Worldwide Envelope Int'l, INT.PW.PAK - Priority Worldwide pak Int'l, INT.PW.PARCEL - Priority Worldwide parcel Int'l, INT.XP - Xpresspost International, INT.SP.AIR - Small Packet International Air, INT.SP.SURF - Small Packet International Surface, INT.TP - Tracked Packet - International]
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
reference_id	string Identifier for a Return Order
reference_number	string Customer supplied internal reference for the order
reason_for_export	string Enum: "SOG" "DOC" "SAM" "REP" "OTH"
nondelivery_option	string Enum: "RASE" "RTS" "ABAN"
delivery_confirmation	string Enum: "SO" "PA18" "PA19"
service_option	string
insurance_type	string Value: "canada_post"
insured_value	number Default: 0
invoice_number	string <= 10 characters Used for customs information: If required by customs at the destination, the commercial invoice number.
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
return	boolean
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"shipper_type": "string",
"shipper_id": 0,
"shipping_method": "string",
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"box_shape": "Parcel",
"length": 0,
"width": 0,
"height": 0,
"weight": 0
}
],
"packing_list_id": 0,
"reference_id": "string",
"reference_number": "string",
"reason_for_export": "SOG",
"nondelivery_option": "RASE",
"delivery_confirmation": "SO",
"service_option": "string",
"insurance_type": "canada_post",
"insured_value": 0,
"invoice_number": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return": true,
"warehouse_id": 0
}

Post Order Label D H L

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id required	integer
weight	number Weight in ounces
length	integer Length in inches
width	integer Width in inches
height	integer Height in inches
box_shape	string Enum: "FLY" "COY" "NCY" "PAL" "DBL" "BOX" optional box type [FLY=Flyer/Smalls - pieces that are too small, thin or light to be sorted on a standard conveyor, or for which it makes sense to group pieces into larger units for sort purposes. COY=Parcels/Conveyables - pieces that can be handled onto a system, less than 31.5 kg and up to 6060120cm. NCY=Non-conveyables - Pieces that cannot on their own be sorted on standard conveyor. PAL=Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. DBL=Double Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. BOX=Parcels that are conveyable have the shape of a box. Up to 70kg.]
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
reason_for_export	string Default: "P" [P - Permanent, T - Temporary, R - Re-Export] It is required for dutiable shipment.
reason_for_export_explanation	string
declared_value	number Shipment Level Declared Value for Dutiable International Shipments
insured_value	number
insurance_type	string Value: "dhl"
shipping_method required	string (dhl_service_types) Enum: "0" "1" "2" "3" "4" "5" "7" "8" "9" "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z" options: [0 - LOGISTICS SERVICES, 1 - DOMESTIC EXPRESS 12:00, 2 - B2C, 3 - B2C, 4 - JETLINE, 5 - SPRINTLINE, 7 - EXPRESS EASY, 8 - EXPRESS EASY, 9 - EUROPACK, A - AUTO REVERSALS, B - BREAKBULK EXPRESS, C - MEDICAL EXPRESS, D - EXPRESS WORLDWIDE, E - EXPRESS 9:00, F - FREIGHT WORLDWIDE, G - DOMESTIC ECONOMY SELECT, H - ECONOMY SELECT, I - DOMESTIC EXPRESS 9:00, J - JUMBO BOX, K - EXPRESS 9:00, L - EXPRESS 10:30, M - EXPRESS 10:30, N - DOMESTIC EXPRESS, O - DOMESTIC EXPRESS 10:30, P - EXPRESS WORLDWIDE, Q - MEDICAL EXPRESS, R - GLOBALMAIL BUSINESS, S - SAME DAY, T - EXPRESS 12:00, U - EXPRESS WORLDWIDE, V - EUROPACK, W - ECONOMY SELECT, X - EXPRESS ENVELOPE, Y - EXPRESS 12:00, Z - Destination Charges]
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
ship_date	string <date-time>
pickup	string <date-time> pickup date time to schedule for the carrier
signature_service	string Value: "SX" signature service option. Signature services are included in international shipments. Use `SX` for no signature required
nonstandard_day	string Enum: "AA" "AB" "AC" "AD" "AG" options are [AA - Saturday Delivery, AB - Saturday Pickup, AC - Holiday Delivery, AD - Holiday Pickup, AG - Domestic Saturday Delivery]
nonstandard_contents	string Enum: "HB" "HC" "HD" "HE" "HG" "HH" "HI" "HK" "HL" "HM" "HN" "HV" "HW" "HY" options are [HB - Lithium Ion PI965 Section II, HC - Dry Ice UN1845, HD - Lithium Ion PI965-966 Section II, HE - Dangerous Goods, HG - Perishable Cargo, HH - Excepted Quantity, HI - Spill Cleaning, HK - Consumer Commodities, HL - Limited Quantities ADR, HM - Lithium Metal PI969 Section II, HN - ADR Load Exemption, HV - Lithium Ion PI967-Section II, HW - Lithium Metal PI970-Section II, HY - Biological UN3373]
is_dutiable	boolean Default: true
federal_tax_id	string <= 20 characters Mandatory for domestic shipment of country code = BR
state_tax_id	string <= 20 characters Mandatory for domestic shipment of country code = BR
duty_payment_type	string Default: "R" Enum: "S" "R" "T" Duties may be paid via Shipper [S], Recipient [R], or Third Party [T]
reference_id	string Identifier for a Return Order
reference_number	string
	object
	object
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
return	boolean Default: false
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
shipping_payment_type	string Default: "S" Enum: "S" "R" "T" Shipping may be paid via Shipper [S], Recipient [R], or Third Party [T]
shipping_payment_account	string Shipment bill to account
duty_payment_account	string Duty bill to account
foreign_trade_regulation	string Enum: "30.2(d)(2)" "30.36" "30.37(a)" "30.37(b)" "30.37(e)" "30.37(f)" "30.37(g)" "30.37(h)" "30.37(i)" "30.37(k)" "30.37(o)" "30.37(q)" "30.37(r)" "30.39" "30.40(a)" "30.40(b)" "30.40(c)" "30.40(d)" Foreign trade regulation code
internal_transaction_number	string 14 characters Internal transaction number provided by the US Customs AES System

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"box_shape": "FLY",
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"declared_value": 0,
"box_shape": "FLY"
}
],
"packing_list_id": 0,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"reason_for_export": "P",
"reason_for_export_explanation": "string",
"declared_value": 0,
"insured_value": 0,
"insurance_type": "dhl",
"shipping_method": "0",
"notify_bill_to": false,
"notify_ship_to": false,
"ship_date": "2019-08-24T14:15:22Z",
"pickup": "2019-08-24T14:15:22Z",
"signature_service": "SX",
"nonstandard_day": "AA",
"nonstandard_contents": "HB",
"is_dutiable": true,
"federal_tax_id": "string",
"state_tax_id": "string",
"duty_payment_type": "S",
"reference_id": "string",
"reference_number": "string",
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return": false,
"warehouse_id": 0,
"shipping_payment_type": "S",
"shipping_payment_account": "string",
"duty_payment_account": "string",
"foreign_trade_regulation": "30.2(d)(2)",
"internal_transaction_number": "stringstringst"
}

Post Order Label D H L Ecommerce

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id required	integer
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
dangerous_goods	string
delivery_confirmation	string Enum: "DELCON" "SIGCON"
service_endorsement	string Enum: "1" "2" "3" "4" 1 - Address Service Requested; 2 - Forwarding Service Requested; 3 - Change Service Requested; 4 - Return Service Requested
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
declared_value	number
insured_value	number
insurance_type	string Value: "dhl_ecommerce"
shipping_method required	string
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
reference_id	string Identifier for a Return Order (RMA)
reference_number	string
ship_date	string <date-time>
	object (tax_info)
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
return	boolean Default: false
return_reason	string reason for return if return is true

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"declared_value": 0,
"description": "string",
"box_shape": "string"
}
],
"packing_list_id": 0,
"dangerous_goods": "string",
"delivery_confirmation": "DELCON",
"service_endorsement": "1",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"declared_value": 0,
"insured_value": 0,
"insurance_type": "dhl_ecommerce",
"shipping_method": "string",
"notify_bill_to": false,
"notify_ship_to": false,
"reference_id": "string",
"reference_number": "string",
"ship_date": "2019-08-24T14:15:22Z",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return": false,
"return_reason": "string"
}

Post Order Label Endicia

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

reference	string package level customer reference value
	Array of objects <= 1 items [ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
packing_list_id	integer id for packing list for profile template associated with this label
contents_type	string to be deprecated in favor of higher use reason_for_export
reason_for_export	string
contents_explanation	string
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "None" Enum: "None" "DeliveryConfirmation" "SignatureConfirmation" "AdultSignature" "AdultSignatureRestrictedDelivery" "RestrictedDelivery"
hold_for_pickup	boolean
insurance_type	string Enum: "discounted_insurance" "endicia"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from address zip code
nondelivery_option	string Default: "Return" Enum: "Return" "Abandon"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
reference_id	string Identifier for a Return Order
reference_number	string Customer supplied internal reference for the order
return	boolean
ship_date	string <date-time>
shipper_id required	integer
shipping_method required	string
stealth	boolean
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"reference": "string",
"packages": [{"box_shape": "SmallFlatRateBox",
"height": 0,
"length": 0,
"reference": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"contents_type": "string",
"reason_for_export": "string",
"contents_explanation": "string",
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "None",
"hold_for_pickup": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "Return",
"notify_bill_to": false,
"notify_ship_to": false,
"reference_id": "string",
"reference_number": "string",
"return": true,
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipping_method": "string",
"stealth": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"warehouse_id": 0
}

Post Order Label Fedex

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

alcohol_shipment_license	string
	object (v1_address)
b13a_filing_option	string Enum: "NOT_REQUIRED" "MANUALLY_ATTACHED" "FILED_ELECTRONICALLY" "SUMMARY_REPORTING" "FEDEX_TO_STAMP" Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands
	object
declared_value	number Package level Insured Value for Fedex
reference_number	string Package level reference, not always necessarily a number
	Array of objects <= 99 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
export_compliance_statement	string For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.
	object
insurance_type	string Enum: "discounted_insurance" "fedex"
insured_value	number Default: 0
label_type	string Enum: "STOCK_4X85_TRAILING_DOC_TAB" "STOCK_4X105_TRAILING_DOC_TAB" FedEx: option for Tire Loss labels with doc tab
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
one_rate	boolean
payment_account	string
payment_type	string
pharmacy_delivery	boolean Default: false
priority_alert	string Enum: "PRIORITY_ALERT" "PRIORITY_ALERT_PLUS"
reason_for_export	string Enum: "SOLD" "NOT_SOLD" "PERSONAL_EFFECTS" "GIFT" "REPAIR_AND_RETURN" "SAMPLE"
reason_for_export_explanation	string
	object (tax_info)
recipient_address_is_residential	boolean
return	boolean
saturday_delivery	boolean Default: false
	object (tax_info)
ship_date	string <date-time>
shipper_id required	integer
shipper_type	string
shipping_method required	string
ancillary_endorsement	string Enum: "ADDRESS_CORRECTION" "CARRIER_LEAVE_IF_NO_RESPONSE" "CHANGE_SERVICE" "FORWARDING_SERVICE" "RETURN_SERVICE" Required for Presorted Standard but not for returns or parcel select. They are not all usable for all ancillary endorsements.
smart_post_hub	string
smart_post_indicia	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
dangerous_goods_option	string
dangerous_goods_regulation_type	string
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
etd_service	boolean
	Array of objects[ items ] for referencing previously uploaded ETD for shipment label
hold_at_location	boolean
hold_at_location_id	string
certificate_of_origin	boolean
terms_of_sale	string <= 3 characters FedEx termsOfSale that will populate the Commercial Invoice (or Pro Forma)
use_metric_units	boolean

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"b13a_filing_option": "NOT_REQUIRED",
"cod": {"collection_type": "ANY",
"amount": 0
},
"declared_value": 0,
"reference_number": "string",
"packages": [{"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"reference": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"export_compliance_statement": "string",
"importer_of_record": {"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"tin": {"tin_type": "BUSINESS_NATIONAL",
"number": "string"
},
"account_number": "string"
},
"insurance_type": "discounted_insurance",
"insured_value": 0,
"label_type": "STOCK_4X85_TRAILING_DOC_TAB",
"notify_bill_to": false,
"notify_ship_to": false,
"one_rate": true,
"payment_account": "string",
"payment_type": "string",
"pharmacy_delivery": false,
"priority_alert": "PRIORITY_ALERT",
"reason_for_export": "SOLD",
"reason_for_export_explanation": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"recipient_address_is_residential": true,
"return": true,
"saturday_delivery": false,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipper_type": "string",
"shipping_method": "string",
"ancillary_endorsement": "ADDRESS_CORRECTION",
"smart_post_hub": "string",
"smart_post_indicia": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"dangerous_goods_option": "string",
"dangerous_goods_regulation_type": "string",
"warehouse_id": 0,
"etd_service": true,
"etd_preshipment_docs": [{"id": "string",
"document_type": "string"
}
],
"hold_at_location": true,
"hold_at_location_id": "string",
"certificate_of_origin": true,
"terms_of_sale": "str",
"use_metric_units": true
}

Post Order Label Fedex360

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

	object (v1_address)
alcohol_shipment_license	string
	object
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
etd_service_default_false	boolean
hold_at_location_id	string
insurance_type	string Value: "discounted_insurance"
insured_value	number Default: 0
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
	Array of objects <= 99 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
payment_account	string
payment_type	string
priority_alert	string Enum: "PRIORITY_ALERT" "PRIORITY_ALERT_PLUS"
reason_for_export	string
reason_for_export_explanation	string
recipient_address_is_residential	boolean
reference_number	string
return	boolean
saturday_delivery	boolean
shipper_id required	integer
shipping_method required	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
ship_date	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"alcohol_shipment_license": "string",
"batteries": {"material": "string",
"packaging": "string"
},
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"etd_service_default_false": true,
"hold_at_location_id": "string",
"insurance_type": "discounted_insurance",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"box_shape": "string",
"dry_ice_weight": 0,
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"payment_account": "string",
"payment_type": "string",
"priority_alert": "PRIORITY_ALERT",
"reason_for_export": "string",
"reason_for_export_explanation": "string",
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": true,
"shipper_id": 0,
"shipping_method": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_date": "2019-08-24T14:15:22Z"
}

Post Order Label Pitney

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

	object (v1_address)
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "DelCon" "Sig" "ADSIG" "ADSIGRD" "SigRD"
hazmat_type	string USPS hazmat input type options
hazmat_electronics	boolean USPS hazmat option for electronics
insurance_type	string Value: "discounted_insurance"
insured_value	number
mailing_zip_code	string mailing post office zip code if different than from address zip code
nondelivery_option	string Enum: "return" "abandon" "redirect"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
	Array of objects[ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
parcel_characteristics	string For nonstandard packages
packing_list_id	integer id for packing list for profile template associated with this label
pitney_rate_type	string
rate_cost	number
reason_for_export	string Enum: "GIFT" "COMMERCIAL_SAMPLE" "MERCHANDISE" "DOCUMENTS" "RETURNED_GOODS" "OTHER"
reason_for_export_explanation	string
reference_id	string RMA only: Identifier for a Return Order
reference_number	string
return	boolean
	object (tax_info)
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer
shipping_method required	string (pitney_shipping_methods) Enum: "ALL" "FCM" "PM" "PMC" "EM" "STDPOST" "PRCLSEL" "MEDIA" "LIB" "FCMI" "FCPIS" "EMI" "PMI" "UGA" USPS service types choices. `ALL` returns all available rates based on box type, dimensions, and addresses. other options include [FCM - First-Class Mail, PM - Priority Mail, PMC - Priority Mail Cubic, EM - Express Mail, STDPOST - Standard Post, PRCLSEL - Parcel Select Ground, MEDIA - Media Mail, LIB - Library Mail, FCMI - First-Class Mail International, FCPIS - First-Class Package International, EMI - Priority Mail Express International, PMI - Priority Mail International]
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "DelCon",
"hazmat_type": "string",
"hazmat_electronics": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "return",
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"parcel_characteristics": "string",
"packing_list_id": 0,
"pitney_rate_type": "string",
"rate_cost": 0,
"reason_for_export": "GIFT",
"reason_for_export_explanation": "string",
"reference_id": "string",
"reference_number": "string",
"return": true,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0,
"shipping_method": "ALL",
"warehouse_id": 0
}

Post Order Label Pitney Presort

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

delivery_confirmation	string Value: "DelCon"
mailing_zip_code	string mailing post office zip code if different than from address zip code
non_delivery	string Enum: "return" "abandon" "reject"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
height	number Height in inches
length	number Length in inches
weight	number Weight in ounces
width	number Width in inches
	Array of objects[ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
packing_list_id	integer id for packing list for profile template associated with this label
reference_number	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer
shipping_method required	string Enum: "BPM" "STANDARD"
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"delivery_confirmation": "DelCon",
"mailing_zip_code": "string",
"non_delivery": "return",
"notify_bill_to": false,
"notify_ship_to": false,
"height": 0,
"length": 0,
"weight": 0,
"width": 0,
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"reference_number": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0,
"shipping_method": "BPM",
"warehouse_id": 0
}

Post Order Label Shippo

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

alcohol_shipment_license	string
	object (v1_address)
ancillary_endorsement	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
dangerous_goods_code	string
dangerous_goods_option	string
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
ignore_bad_address	boolean
insurance_type	string Enum: "shippo" "FEDEX" "ONTRAC" "UPS"
insured_value	number Default: 0
required	Array of objects <= 99 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
payment_account	string Account number to be billed
payment_country	string Country iso2 code of account number to be billed (required for UPS third party billing only).
payment_type	string Party to be billed. Available options: SENDER, RECIPIENT, THIRD_PARTY, THIRD_PARTY_CONSIGNEE, COLLECT
payment_zip	string ZIP code of account number to be billed (required for UPS if there is a zip on the billing account).
rate_id	string id of the rate created when fetching rates with shippo, returned on rates response
reference_id	string Identifier for a Return Order
reason_for_export	string Enum: "DOCUMENTS" "GIFT" "HUMANITARIAN_DONATION" "MERCHANDISE" "OTHER" "RETURN_MERCHANDISE" "SAMPLE"
reason_for_export_explanation	string
recipient_address_is_residential	boolean
reference_number	string shipment customer reference value
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean Default: false
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipment_id	string id of the shipment created when fetching rates with shippo, returned on rates response
shipper_id required	integer id of the Ordoro shipper to use when creating the label
shipping_method	string

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ancillary_endorsement": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"dangerous_goods_code": "string",
"dangerous_goods_option": "string",
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"ignore_bad_address": true,
"insurance_type": "shippo",
"insured_value": 0,
"packages": [{"box_shape": "string",
"dry_ice_weight": 0,
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"payment_account": "string",
"payment_country": "string",
"payment_type": "string",
"payment_zip": "string",
"rate_id": "string",
"reference_id": "string",
"reason_for_export": "DOCUMENTS",
"reason_for_export_explanation": "string",
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipment_id": "string",
"shipper_id": 0,
"shipping_method": "string"
}

Post Order Label U P S

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

additional_handling	boolean
	object (v1_address)
certificate_origin	boolean Default: false
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string ['0' - None, '1' - Confirm, '2' - Signature, '3' - Adult Signature, '4' - USPS for use with Mail Innovations]
direct_delivery	boolean
dry_ice_regulation_set	string indicates dry ice shipment option [CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada, IATA = For Worldwide Air movement]
insurance_type	string
insured_value	number Default: 0
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
box_shape	string ups box options [01 - UPS Letter, 02 - Customer Supplied Package, 03 - Tube, 04 - PAK, 2a - Small Express Box, 2b - Medium Express Box, 2c - Large Express Box, 24 - UPS 25KG Box, 25 - UPS 10KG Box]
declared_value	number Package level declared value for UPS
description	string Package level description, required for return shipments
dry_ice_weight	number Dry ice weight in ounces, required for dry ice shipments
height	number Height in inches
length	number Length in inches
weight	number weight of the package in ounces
width	number Width in inches
	Array of objects <= 200 items [ items ]
package_bill_type	string Enum: "02" "03" "04" "07" required for shoptimeintransit rates: document, non-document, wwef pallet, or domestic pallet. describes the contents of the package.
packing_list_id	integer id for packing list for profile template associated with this label
payment_type	string Default: "BillShipper" payor for the shipment [BillShipper, BillReceiver, BillThirdParty]
payment_account	string account number for payment type
payment_zip	string postal code of the payor, required for payment_type: BillThirdParty
payment_country	string 2 character country code of the payor, required for payment_type: BillThirdParty
duties_payment_type	string Default: "BillShipper" payor for the shipment [BillShipper, BillReceiver, BillThirdParty]
duties_payment_account	string account number for payment type
duties_payment_zip	string postal code of the payor, required for payment_type: BillThirdParty
duties_payment_country	string 2 character country code of the payor, required for payment_type: BillThirdParty
purchase_order_number	string Customs level purchase order number reference
reason_for_export	string
	object (tax_info)
receiver_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
recipient_address_is_residential	boolean
reference_number	string Customer supplied internal reference for the order
return	boolean
saturday_delivery	boolean Default: false
	object (tax_info)
sender_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
shipper_id required	integer
shipper_type	string
shipping_method required	string options: ['01' - Next Day, '02' - Second Day, '03' - Ground, '07' - Worldwide Express, '08' - Worldwide Expedited, '11' - Standard, '12' - Three Day Select, '13' - Next Day Air Saver, '14' - Next Day AM, '54' - Worldwide Express Plus, '59' - Second Day AM, '65' - Saver, '92' - SurePost Less Than 1 lb, '93' - SurePost Greater Than 1lb, '94' - SurePost BPM, '95' - SurePost Media; The following service types are used with UPS Mail Innovations: 'M2' - USPS First Class Mail, 'M3' - USPS Priority Mail, 'M4' - Expedited Mail Innovations, 'M5' - Priority Mail Innovations, 'M6' - Economy Mail Innovations]
shipper_release	boolean
ship_date	string <date-time> Used for label requests in customs forms export date or commercial invoice: invoice date
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
usps_endorsement	string Required for UPS Mail Innovations shipments
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
cost_center	string <= 30 characters The Cost Center code for UPS Mail Innovations shipments

Responses

Request samples

Payload

Content type

application/json

{"additional_handling": true,
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"certificate_origin": false,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"direct_delivery": true,
"dry_ice_regulation_set": "string",
"insurance_type": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"height": 0,
"length": 0,
"weight": 0,
"width": 0,
"packages": [{"additional_handling": true,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_regulation_set": "string",
"dry_ice_weight": 0,
"hazmat_items": [{"additional_description": "string",
"class_division_number": "string",
"commodity_regulated_level_code": "EQ",
"emergency_contact": "string",
"emergency_phone": "string",
"hazard_label_required": "string",
"id_number": "string",
"packaging_instruction_code": "string",
"packaging_group_type": null,
"packaging_type": "string",
"packaging_type_quantity": "string",
"proper_shipping_name": "string",
"quantity": "string",
"regulation_set": "ADR",
"reportable_quantity": "string",
"sub_risk_class": "string",
"technical_name": "string",
"transport_category": "0",
"transportation_mode": "Cargo Aircraft Only",
"tunnel_restriction_code": "(B)",
"uom": "string"
}
],
"height": 0,
"length": 0,
"reference_number": "string",
"weight": 0,
"width": 0
}
],
"package_bill_type": "02",
"packing_list_id": 0,
"payment_type": "BillShipper",
"payment_account": "string",
"payment_zip": "string",
"payment_country": "string",
"duties_payment_type": "BillShipper",
"duties_payment_account": "string",
"duties_payment_zip": "string",
"duties_payment_country": "string",
"purchase_order_number": "string",
"reason_for_export": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_type": "string",
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"sender_type": "string",
"shipper_id": 0,
"shipper_type": "string",
"shipping_method": "string",
"shipper_release": true,
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"usps_endorsement": "string",
"warehouse_id": 0,
"cost_center": "string"
}

Post Order Label U S P S Ship

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id required	integer
shipping_method required	string options: 'ALL', 'BOUND_PRINTED_MATTER', 'FIRST-CLASS_MAIL', 'FIRST-CLASS_PACKAGE_INTERNATIONAL_SERVICE', 'FIRST-CLASS_PACKAGE_SERVICE', 'LIBRARY_MAIL', 'MARKETING_MAIL_PARCELS', 'MEDIA_MAIL', 'PARCEL_SELECT_LIGHTWEIGHT', 'PARCEL_SELECT', 'PRIORITY_MAIL_EXPRESS_INTERNATIONAL', 'PRIORITY_MAIL_EXPRESS', 'PRIORITY_MAIL_INTERNATIONAL', 'PRIORITY_MAIL', 'USPS_CONNECT_LOCAL', 'USPS_CONNECT_MAIL', 'USPS_CONNECT_REGIONAL', 'USPS_GROUND_ADVANTAGE'
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
ship_date	string <date-time>
	object (v1_address)
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "921" "922" "923" "924" "981"
insurance_type	string Value: "discounted_insurance"
insured_value	number Default: 0
has_nonstandard_characteristics	boolean
nondelivery_option	string Enum: "RETURN" "ABANDON" "REDIRECT"
mailing_zip_code	string mailing post office zip code if different than from address zip code
	Array of objects[ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
packing_list_id	integer id for packing list for profile template associated with this label
processing_category required	string Enum: "MACHINABLE" "FLATS" "NONSTANDARD" "LETTERS" returned on rates to be used for label creation
rate_indicator	string from the rate response
reason_for_export	string Enum: "COMMERCIAL_SAMPLE" "CREMATED_REMAINS" "DANGEROUS_GOODS" "DOCUMENT" "GIFT" "HUMANITARIAN_DONATIONS" "MEDICAL_SUPPLIES" "MERCHANDISE" "NON_NEGOTIABLE_DOCUMENT" "OTHER" "PHARMACEUTICALS" "RETURNED_GOODS"
reason_for_export_explanation	string
reference_id	string
reference_number	string
	object (tax_info)
	object (tax_info)
return	boolean
invoice_number	string
hazmat_type	string hazmat input type options
ignore_bad_address	boolean

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"shipping_method": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"notify_bill_to": false,
"notify_ship_to": false,
"ship_date": "2019-08-24T14:15:22Z",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "921",
"insurance_type": "discounted_insurance",
"insured_value": 0,
"has_nonstandard_characteristics": true,
"nondelivery_option": "RETURN",
"mailing_zip_code": "string",
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"processing_category": "MACHINABLE",
"rate_indicator": "string",
"reason_for_export": "COMMERCIAL_SAMPLE",
"reason_for_export_explanation": "string",
"reference_id": "string",
"reference_number": "string",
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"return": true,
"invoice_number": "string",
"hazmat_type": "string",
"ignore_bad_address": true
}

Order Rate V3

Post Order Rate

fetch rates for an order based on label_info.config

Authorizations:

APIKey

path Parameters

order_number

required

string

Responses

Post Order Rate Amazon

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id	integer
delivery_confirmation required	string Enum: "DeliveryConfirmationWithAdultSignature" "DeliveryConfirmationWithoutSignature" "DeliveryConfirmationWithSignature" "NoPreference" "NoTracking"
weight	number Weight in ounces
length	number Length in inches
width	number Width in inches
height	number Height in inches
box_shape	string
	Array of objects <= 1 items [ items ]
shipping_method	string
ship_date	string <date-time>
arrive_by_date	string <date-time>
carrier_pickup	boolean
	object (v1_address) The ship_from address is used as the source of the shipment label. This can be a warehouse or a supplier address.
insurance_type	string Value: "amazon"
insured_value	number Default: 0
is_hazmat	boolean Default: false boolean indicator for hazardous materials
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"delivery_confirmation": "DeliveryConfirmationWithAdultSignature",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"box_shape": "string",
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"box_shape": "string"
}
],
"shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"arrive_by_date": "2019-08-24T14:15:22Z",
"carrier_pickup": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"insurance_type": "amazon",
"insured_value": 0,
"is_hazmat": false,
"warehouse_id": 0
}

Post Order Rate Amazon Shipper

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

is_hazmat	boolean Default: false boolean indicator for hazardous materials
	Array of objects <= 1 items [ items ]
recipient_address_is_residential	boolean
reference_number	string
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer

Responses

Request samples

Payload

Content type

application/json

{"is_hazmat": false,
"packages": [{"box_shape": "string",
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"weight": 0,
"width": 0
}
],
"recipient_address_is_residential": true,
"reference_number": "string",
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0
}

Post Order Rate Australia Post

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

box_shape	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string
insurance_type	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
required	Array of objects <= 200 items [ items ]
reason_for_export	string
reference_number	string Package level reference, not always necessarily a number
ship_date	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer
reference_id	string Identifier for a Return Order
shipping_method	string ignored for rate requests
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"box_shape": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"insurance_type": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"additional_handling": true,
"box_shape": "string",
"height": 0,
"length": 0,
"reference_number": "string",
"reference": "string",
"weight": 0,
"width": 0
}
],
"reason_for_export": "string",
"reference_number": "string",
"ship_date": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0,
"reference_id": "string",
"shipping_method": "string"
}

Post Order Rate Canada Post

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

reason_for_export	string Enum: "SOG" "DOC" "SAM" "REP" "OTH"
nondelivery_option	string Enum: "RASE" "RTS" "ABAN"
delivery_confirmation	string Enum: "SO" "PA18" "PA19"
service_option	string
insurance_type	string Value: "canada_post"
insured_value	number Default: 0
shipper_id required	integer
	Array of objects <= 1 items [ items ]
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"reason_for_export": "SOG",
"nondelivery_option": "RASE",
"delivery_confirmation": "SO",
"service_option": "string",
"insurance_type": "canada_post",
"insured_value": 0,
"shipper_id": 0,
"packages": [{"box_shape": "Parcel",
"length": 0,
"width": 0,
"height": 0,
"weight": 0
}
],
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"return": true,
"warehouse_id": 0
}

Post Order Rate D H L

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id required	integer
	Array of objects <= 1 items [ items ]
declared_value	number Shipment Level Declared Value for Dutiable International Shipments
insured_value	number
insurance_type	string Value: "dhl"
ship_date	string <date-time>
reference_number	string
pickup	string <date-time> pickup date time to schedule for the carrier
signature_service	string Value: "SX" signature service option. Signature services are included in international shipments. Use `SX` for no signature required
nonstandard_day	string Enum: "AA" "AB" "AC" "AD" "AG" options are [AA - Saturday Delivery, AB - Saturday Pickup, AC - Holiday Delivery, AD - Holiday Pickup, AG - Domestic Saturday Delivery]
nonstandard_contents	string Enum: "HB" "HC" "HD" "HE" "HG" "HH" "HI" "HK" "HL" "HM" "HN" "HV" "HW" "HY" options are [HB - Lithium Ion PI965 Section II, HC - Dry Ice UN1845, HD - Lithium Ion PI965-966 Section II, HE - Dangerous Goods, HG - Perishable Cargo, HH - Excepted Quantity, HI - Spill Cleaning, HK - Consumer Commodities, HL - Limited Quantities ADR, HM - Lithium Metal PI969 Section II, HN - ADR Load Exemption, HV - Lithium Ion PI967-Section II, HW - Lithium Metal PI970-Section II, HY - Biological UN3373]
is_dutiable	boolean Default: true
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
return	boolean Default: false For orders, determines whether the originating and destination addresses will be swapped for a return label request
warehouse_id	integer DEPRECATED: ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"declared_value": 0,
"box_shape": "FLY"
}
],
"declared_value": 0,
"insured_value": 0,
"insurance_type": "dhl",
"ship_date": "2019-08-24T14:15:22Z",
"reference_number": "string",
"pickup": "2019-08-24T14:15:22Z",
"signature_service": "SX",
"nonstandard_day": "AA",
"nonstandard_contents": "HB",
"is_dutiable": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"return": false,
"warehouse_id": 0
}

Post Order Rate D H L Ecommerce

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id required	integer
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
dangerous_goods	string
delivery_confirmation	string Enum: "DELCON" "SIGCON"
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
declared_value	number
insured_value	number
insurance_type	string Value: "dhl_ecommerce"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
ship_date	string <date-time>
	object (tax_info)
reference_number	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
return	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"declared_value": 0,
"description": "string",
"box_shape": "string"
}
],
"packing_list_id": 0,
"dangerous_goods": "string",
"delivery_confirmation": "DELCON",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"declared_value": 0,
"insured_value": 0,
"insurance_type": "dhl_ecommerce",
"notify_bill_to": false,
"notify_ship_to": false,
"ship_date": "2019-08-24T14:15:22Z",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"reference_number": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return": false
}

Post Order Rate Endicia

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

	Array of objects <= 1 items [ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
contents_type	string to be deprecated in favor of higher use reason_for_export
reason_for_export	string
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "None" Enum: "None" "DeliveryConfirmation" "SignatureConfirmation" "AdultSignature" "AdultSignatureRestrictedDelivery" "RestrictedDelivery"
hold_for_pickup	boolean
insurance_type	string Enum: "discounted_insurance" "endicia"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from address zip code
nondelivery_option	string Default: "Return" Enum: "Return" "Abandon"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
reference_number	string Customer supplied internal reference for an order
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
ship_date	string <date-time>
shipper_id required	integer
shipping_method	string
stealth	boolean NOTE: Ignored for rates. Display indicia on the label
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"packages": [{"box_shape": "SmallFlatRateBox",
"height": 0,
"length": 0,
"reference": "string",
"weight": 0,
"width": 0
}
],
"contents_type": "string",
"reason_for_export": "string",
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "None",
"hold_for_pickup": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "Return",
"notify_bill_to": false,
"notify_ship_to": false,
"reference_number": "string",
"return": true,
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipping_method": "string",
"stealth": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"warehouse_id": 0
}

Post Order Rate Fedex

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

alcohol_shipment_license	string
b13a_filing_option	string Enum: "NOT_REQUIRED" "MANUALLY_ATTACHED" "FILED_ELECTRONICALLY" "SUMMARY_REPORTING" "FEDEX_TO_STAMP" Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands
declared_value	number Package level Insured Value for Fedex
	Array of objects[ items ] for referencing previously uploaded ETD for shipment label
	Array of objects <= 99 items [ items ]
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
export_compliance_statement	string For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.
	object
insurance_type	string Enum: "discounted_insurance" "fedex"
insured_value	number Default: 0
one_rate	boolean
payment_account	string
payment_type	string
pharmacy_delivery	boolean Default: false
priority_alert	string Enum: "PRIORITY_ALERT" "PRIORITY_ALERT_PLUS"
reason_for_export	string Enum: "SOLD" "NOT_SOLD" "PERSONAL_EFFECTS" "GIFT" "REPAIR_AND_RETURN" "SAMPLE"
reason_for_export_explanation	string
	object (tax_info)
recipient_address_is_residential	boolean
reference_number	string
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean Default: false
	object (tax_info)
ship_date	string <date-time>
shipper_id required	integer
ancillary_endorsement	string Enum: "ADDRESS_CORRECTION" "CARRIER_LEAVE_IF_NO_RESPONSE" "CHANGE_SERVICE" "FORWARDING_SERVICE" "RETURN_SERVICE" Required for Presorted Standard but not for returns or parcel select. They are not all usable for all ancillary endorsements.
smart_post_hub	string
smart_post_indicia	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
dangerous_goods_option	string
dangerous_goods_regulation_type	string
etd_service	boolean
hold_at_location	boolean
hold_at_location_id	string
certificate_of_origin	boolean
use_metric_units	boolean

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"b13a_filing_option": "NOT_REQUIRED",
"declared_value": 0,
"etd_preshipment_docs": [{"id": "string",
"document_type": "string"
}
],
"packages": [{"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"reference": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"export_compliance_statement": "string",
"importer_of_record": {"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"tin": {"tin_type": "BUSINESS_NATIONAL",
"number": "string"
},
"account_number": "string"
},
"insurance_type": "discounted_insurance",
"insured_value": 0,
"one_rate": true,
"payment_account": "string",
"payment_type": "string",
"pharmacy_delivery": false,
"priority_alert": "PRIORITY_ALERT",
"reason_for_export": "SOLD",
"reason_for_export_explanation": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"ancillary_endorsement": "ADDRESS_CORRECTION",
"smart_post_hub": "string",
"smart_post_indicia": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"dangerous_goods_option": "string",
"dangerous_goods_regulation_type": "string",
"etd_service": true,
"hold_at_location": true,
"hold_at_location_id": "string",
"certificate_of_origin": true,
"use_metric_units": true
}

Post Order Rate Pitney

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "DelCon" "Sig" "ADSIG" "ADSIGRD" "SigRD"
hazmat_type	string USPS hazmat input type options
hazmat_electronics	boolean USPS hazmat option for electronics
insurance_type	string Value: "discounted_insurance"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from_address zip code, ignored in rate request
nondelivery_option	string Enum: "return" "abandon" "redirect"
	Array of objects <= 1 items [ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
parcel_characteristics	string For nonstandard packages
pitney_rate_type	string
reason_for_export	string Enum: "GIFT" "COMMERCIAL_SAMPLE" "MERCHANDISE" "DOCUMENTS" "RETURNED_GOODS" "OTHER"
reason_for_export_explanation	string
reference_number	string
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
	object (tax_info)
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
shipper_id required	integer
shipping_method required	string
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "DelCon",
"hazmat_type": "string",
"hazmat_electronics": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "return",
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"parcel_characteristics": "string",
"pitney_rate_type": "string",
"reason_for_export": "GIFT",
"reason_for_export_explanation": "string",
"reference_number": "string",
"return": true,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"shipper_id": 0,
"shipping_method": "string",
"warehouse_id": 0
}

Post Order Rate Shippo

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

alcohol_shipment_license	string
	object (v1_address)
ancillary_endorsement	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
dangerous_goods_code	string
dangerous_goods_option	string
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
ignore_bad_address	boolean
insurance_type	string Enum: "shippo" "FEDEX" "ONTRAC" "UPS"
insured_value	number Default: 0
required	Array of objects <= 99 items [ items ]
payment_account	string Account number to be billed
payment_country	string Country iso2 code of account number to be billed (required for UPS third party billing only).
payment_type	string Party to be billed. Available options: SENDER, RECIPIENT, THIRD_PARTY, THIRD_PARTY_CONSIGNEE, COLLECT
payment_zip	string ZIP code of account number to be billed (required for UPS if there is a zip on the billing account).
reference_id	string Identifier for a Return Order
reason_for_export	string Enum: "DOCUMENTS" "GIFT" "HUMANITARIAN_DONATION" "MERCHANDISE" "OTHER" "RETURN_MERCHANDISE" "SAMPLE"
reason_for_export_explanation	string
recipient_address_is_residential	boolean
reference_number	string shipment customer reference value
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean Default: false
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer
shipping_method	string

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ancillary_endorsement": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"dangerous_goods_code": "string",
"dangerous_goods_option": "string",
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"ignore_bad_address": true,
"insurance_type": "shippo",
"insured_value": 0,
"packages": [{"box_shape": "string",
"dry_ice_weight": 0,
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"payment_account": "string",
"payment_country": "string",
"payment_type": "string",
"payment_zip": "string",
"reference_id": "string",
"reason_for_export": "DOCUMENTS",
"reason_for_export_explanation": "string",
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0,
"shipping_method": "string"
}

Post Order Rate U P S

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

additional_handling	boolean
	object (v1_address)
certificate_origin	boolean
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string ['0' - None, '1' - Confirm, '2' - Signature, '3' - Adult Signature]
direct_delivery	boolean
dry_ice_regulation_set	string indicates dry ice shipment option [CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada, IATA = For Worldwide Air movement]
insurance_type	string
insured_value	number
box_shape	string DEPRECATED: USE PACKAGES. ups box options [01 - UPS Letter, 02 - Customer Supplied Package, 03 - Tube, 04 - PAK, 2a - Small Express Box, 2b - Medium Express Box, 2c - Large Express Box, 24 - UPS 25KG Box, 25 - UPS 10KG Box]
declared_value	number DEPRECATED: USE PACKAGES. Package level declared value for UPS
description	string DEPRECATED: USE PACKAGES. Package level description, required for return label creation
dry_ice_weight	number DEPRECATED: USE PACKAGES. Dry ice weight in ounces, required for dry ice shipments
purchase_order_number	string Customs level purchase order number reference
reference_number	string Package level reference, not always necessarily a number
weight	number DEPRECATED: USE PACKAGES. Weight in ounces
length	number DEPRECATED: USE PACKAGES. Length in inches
width	number DEPRECATED: USE PACKAGES. Width in inches
height	number DEPRECATED: USE PACKAGES. Height in inches
	Array of objects <= 200 items [ items ]
package_bill_type	string Enum: "02" "03" "04" "07" required for shoptimeintransit rates: document, non-document, wwef pallet, or domestic pallet. describes the contents of the package.
payment_type	string
payment_account	string
payment_zip	string
payment_country	string
duties_payment_type	string
duties_payment_account	string
duties_payment_zip	string
duties_payment_country	string
reason_for_export	string
	object (tax_info)
receiver_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
recipient_address_is_residential	boolean
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean
	object (tax_info)
sender_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
shipper_id required	integer
shipping_method	string
shipper_release	boolean
usps_endorsement	string Required for UPS Mail Innovations shipments
ship_date	string <date-time> Used for label requests in customs forms export date or commercial invoice: invoice date
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
cost_center	string The Cost Center code for UPS Mail Innovations shipments

Responses

Request samples

Payload

Content type

application/json

{"additional_handling": true,
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"certificate_origin": true,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"direct_delivery": true,
"dry_ice_regulation_set": "string",
"insurance_type": "string",
"insured_value": 0,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"purchase_order_number": "string",
"reference_number": "string",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"packages": [{"additional_handling": true,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_regulation_set": "string",
"dry_ice_weight": 0,
"hazmat_items": [{"additional_description": "string",
"class_division_number": "string",
"commodity_regulated_level_code": "EQ",
"emergency_contact": "string",
"emergency_phone": "string",
"hazard_label_required": "string",
"id_number": "string",
"packaging_instruction_code": "string",
"packaging_group_type": null,
"packaging_type": "string",
"packaging_type_quantity": "string",
"proper_shipping_name": "string",
"quantity": "string",
"regulation_set": "ADR",
"reportable_quantity": "string",
"sub_risk_class": "string",
"technical_name": "string",
"transport_category": "0",
"transportation_mode": "Cargo Aircraft Only",
"tunnel_restriction_code": "(B)",
"uom": "string"
}
],
"height": 0,
"length": 0,
"reference_number": "string",
"weight": 0,
"width": 0
}
],
"package_bill_type": "02",
"payment_type": "string",
"payment_account": "string",
"payment_zip": "string",
"payment_country": "string",
"duties_payment_type": "string",
"duties_payment_account": "string",
"duties_payment_zip": "string",
"duties_payment_country": "string",
"reason_for_export": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_type": "string",
"recipient_address_is_residential": true,
"return": true,
"saturday_delivery": true,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"sender_type": "string",
"shipper_id": 0,
"shipping_method": "string",
"shipper_release": true,
"usps_endorsement": "string",
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"warehouse_id": 0,
"cost_center": "string"
}

Post Order Rate U S P S Ship

Authorizations:

APIKey

path Parameters

order_number

required

string

Request Body schema: application/json

shipper_id required	integer
shipping_method	string options: 'ALL', 'BOUND_PRINTED_MATTER', 'FIRST-CLASS_MAIL', 'FIRST-CLASS_PACKAGE_INTERNATIONAL_SERVICE', 'FIRST-CLASS_PACKAGE_SERVICE', 'LIBRARY_MAIL', 'MARKETING_MAIL_PARCELS', 'MEDIA_MAIL', 'PARCEL_SELECT_LIGHTWEIGHT', 'PARCEL_SELECT', 'PRIORITY_MAIL_EXPRESS_INTERNATIONAL', 'PRIORITY_MAIL_EXPRESS', 'PRIORITY_MAIL_INTERNATIONAL', 'PRIORITY_MAIL', 'USPS_CONNECT_LOCAL', 'USPS_CONNECT_MAIL', 'USPS_CONNECT_REGIONAL', 'USPS_GROUND_ADVANTAGE'
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
ship_date	string <date-time>
	object (v1_address)
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "921" "922" "923" "924" "981"
has_nonstandard_characteristics	boolean
insurance_type	string Value: "discounted_insurance"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from address zip code
	Array of objects[ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
processing_category	string Enum: "MACHINABLE" "FLATS" "NONSTANDARD" "LETTERS" optional for filtering rates
reason_for_export	string Enum: "COMMERCIAL_SAMPLE" "CREMATED_REMAINS" "DANGEROUS_GOODS" "DOCUMENTS" "GIFT" "HUMANITARIAN_DONATIONS" "MEDICAL_SUPPLIES" "MERCHANDISE" "NON_NEGOTIABLE_DOCUMENT" "OTHER" "PHARMACEUTICALS" "RETURNED_GOODS"
reason_for_export_explanation	string
reference_number	string
return	boolean
hazmat_type	string hazmat input type options

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"shipping_method": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_date": "2019-08-24T14:15:22Z",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "921",
"has_nonstandard_characteristics": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"processing_category": "MACHINABLE",
"reason_for_export": "COMMERCIAL_SAMPLE",
"reason_for_export_explanation": "string",
"reference_number": "string",
"return": true,
"hazmat_type": "string"
}

Packing List

Delete Packing List

Authorizations:

APIKey

Responses

Get Packing List

Authorizations:

APIKey

query Parameters

packing_list_id

Array of strings

Responses

Post Packing List

Authorizations:

APIKey

Request Body schema: application/json

name required	string <= 255 characters
branded_tracking	object or null
custom_layouts	object
custom_text	string or null
email	string or null <= 75 characters
phone	string or null <= 255 characters
website	string or null <= 255 characters
footer	string or null
return_email_subject	string or null <= 255 characters
return_email_content	string or null <= 1024 characters
ship_from_alias_name	string or null <= 255 characters
customer_notes_label	string or null <= 255 characters
logo_hash	string or null <= 255 characters
is_default	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"branded_tracking": { },
"custom_layouts": { },
"custom_text": "string",
"email": "string",
"phone": "string",
"website": "string",
"footer": "string",
"return_email_subject": "string",
"return_email_content": "string",
"ship_from_alias_name": "string",
"customer_notes_label": "string",
"logo_hash": "string",
"is_default": true
}

Put Packing List

Authorizations:

APIKey

Request Body schema: application/json

name	string <= 255 characters
branded_tracking	object or null
custom_layouts	object
custom_text	string or null
email	string or null <= 75 characters
phone	string or null <= 255 characters
website	string or null <= 255 characters
footer	string or null
return_email_subject	string or null <= 255 characters
return_email_content	string or null <= 1024 characters
ship_from_alias_name	string or null <= 255 characters
customer_notes_label	string or null <= 255 characters
logo_hash	string or null <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"branded_tracking": { },
"custom_layouts": { },
"custom_text": "string",
"email": "string",
"phone": "string",
"website": "string",
"footer": "string",
"return_email_subject": "string",
"return_email_content": "string",
"ship_from_alias_name": "string",
"customer_notes_label": "string",
"logo_hash": "string"
}

Delete Packing List

Authorizations:

APIKey

path Parameters

packing_list_id

required

integer

Responses

Get Packing List

Authorizations:

APIKey

path Parameters

packing_list_id

required

integer

Responses

Post Packing List

Authorizations:

APIKey

path Parameters

packing_list_id

required

integer

Request Body schema: application/json

name required	string <= 255 characters
branded_tracking	object or null
custom_layouts	object
custom_text	string or null
email	string or null <= 75 characters
phone	string or null <= 255 characters
website	string or null <= 255 characters
footer	string or null
return_email_subject	string or null <= 255 characters
return_email_content	string or null <= 1024 characters
ship_from_alias_name	string or null <= 255 characters
customer_notes_label	string or null <= 255 characters
logo_hash	string or null <= 255 characters
is_default	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"branded_tracking": { },
"custom_layouts": { },
"custom_text": "string",
"email": "string",
"phone": "string",
"website": "string",
"footer": "string",
"return_email_subject": "string",
"return_email_content": "string",
"ship_from_alias_name": "string",
"customer_notes_label": "string",
"logo_hash": "string",
"is_default": true
}

Put Packing List

Authorizations:

APIKey

path Parameters

packing_list_id

required

integer

Request Body schema: application/json

name	string <= 255 characters
branded_tracking	object or null
custom_layouts	object
custom_text	string or null
email	string or null <= 75 characters
phone	string or null <= 255 characters
website	string or null <= 255 characters
footer	string or null
return_email_subject	string or null <= 255 characters
return_email_content	string or null <= 1024 characters
ship_from_alias_name	string or null <= 255 characters
customer_notes_label	string or null <= 255 characters
logo_hash	string or null <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"branded_tracking": { },
"custom_layouts": { },
"custom_text": "string",
"email": "string",
"phone": "string",
"website": "string",
"footer": "string",
"return_email_subject": "string",
"return_email_content": "string",
"ship_from_alias_name": "string",
"customer_notes_label": "string",
"logo_hash": "string"
}

Post Packing List Make Default

Authorizations:

APIKey

path Parameters

packing_list_id

required

integer

Responses

Preset

Delete Preset

Authorizations:

APIKey

Responses

Get Preset

Authorizations:

APIKey

Responses

Post Preset

Authorizations:

APIKey

Responses

Put Preset

Authorizations:

APIKey

Responses

Delete Preset

Authorizations:

APIKey

path Parameters

preset_id

required

integer

Responses

Get Preset

Authorizations:

APIKey

path Parameters

preset_id

required

integer

Responses

Post Preset

Authorizations:

APIKey

path Parameters

preset_id

required

integer

Responses

Put Preset

Authorizations:

APIKey

path Parameters

preset_id

required

integer

Responses

Print Config

Delete Print Config

Authorizations:

APIKey

Responses

Get Print Config

Authorizations:

APIKey

query Parameters

limit	integer Default: 100
offset	integer Default: 0

Responses

Post Print Config

Authorizations:

APIKey

Request Body schema: application/json

name required	string
	object (print_config_settings)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"settings": {"layout": "string",
"type": "string",
"allowed_params": ["string"
],
"defaults": { }
}
}

Put Print Config

Authorizations:

APIKey

Request Body schema: application/json

name	string
	object (print_config_settings)
archive_date	null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"settings": {"layout": "string",
"type": "string",
"allowed_params": ["string"
],
"defaults": { }
},
"archive_date": null
}

Delete Print Config

Authorizations:

APIKey

path Parameters

print_config_id

required

integer

Responses

Get Print Config

Authorizations:

APIKey

path Parameters

print_config_id

required

integer

Responses

Post Print Config

Authorizations:

APIKey

path Parameters

print_config_id

required

integer

Request Body schema: application/json

name required	string
	object (print_config_settings)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"settings": {"layout": "string",
"type": "string",
"allowed_params": ["string"
],
"defaults": { }
}
}

Put Print Config

Authorizations:

APIKey

path Parameters

print_config_id

required

integer

Request Body schema: application/json

name	string
	object (print_config_settings)
archive_date	null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"settings": {"layout": "string",
"type": "string",
"allowed_params": ["string"
],
"defaults": { }
},
"archive_date": null
}

Product

Get Product

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
fba	string
fbm	string
category	Array of strings
hs_code	Array of strings
m_pid	Array of strings
ns_pid	Array of strings
s_pid	Array of strings
active	string
kit	string
kit_component	string
manufactured	string
manufacturing_component	string
dropship	string
needs_sync	string
inventory_sync_suspended	string
supplier	Array of integers[ items ]
no_supplier	string
sales_channel	Array of integers[ items ]
low_inventory_aoh	string
low_inventory_poh	string
to_be_shipped	string
oversold	string
reordered	string
overallocated	string
tag	Array of strings
untagged	string
exclude_tags	Array of strings
tag_filter_by	string
warehouse_id	Array of integers[ items ]
sku	Array of strings
product_type	string
fulfillment_type	Array of strings
updated_after	string <date-time>
updated_before	string <date-time>
barcode	Array of strings
stocktake_reference_id	string
cart	integer

Responses

Head Product

Authorizations:

APIKey

Responses

Post Product

Authorizations:

APIKey

Request Body schema: application/json

sku	string
name	string <= 1000 characters
category	string
hs_code	string <= 25 characters
m_pid	string <= 255 characters
ns_pid	string <= 255 characters
s_pid	string <= 255 characters
country_of_origin	string <= 100 characters
customs_description	string
declared_value	number
price	number
weight	number
length	integer
height	integer
width	integer
taxable	string <= 100 characters
cost	number
type	string <= 1000 characters
upc	string <= 100 characters
asin	string <= 10 characters
internal_notes	string
has_serial_numbers	string
is_digital	string
needs_order_line_labels	string
physical_on_hand	number
low_stock_threshold	number
out_of_stock_threshold	number
warehouses	Array of strings
location_in_warehouse	string <= 255 characters
cart	integer
sync	string
original_sku	string <= 255 characters
variant_sku	string <= 255 characters
inventory_changed	string
max_export_qty	integer
write_back_consecutive_failures	integer
write_back_suspended_date	string <date-time>
mo_internal_notes	string
mo_manufacturer_notes	string
images	Array of strings
tags	Array of strings
amazon_extra_info	string
ebay_extra_info	Array of strings
etsy_extra_info	string
shopify_extra_info	string
square_extra_info	string
squarespace_extra_info	string
walmart_extra_info	string
wayfair_extra_info	string
audit_import	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"category": "string",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "string",
"customs_description": "string",
"declared_value": 0,
"price": 0,
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"taxable": "string",
"cost": 0,
"type": "string",
"upc": "string",
"asin": "string",
"internal_notes": "string",
"has_serial_numbers": "string",
"is_digital": "string",
"needs_order_line_labels": "string",
"physical_on_hand": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"warehouses": ["string"
],
"location_in_warehouse": "string",
"cart": 0,
"sync": "string",
"original_sku": "string",
"variant_sku": "string",
"inventory_changed": "string",
"max_export_qty": 0,
"write_back_consecutive_failures": 0,
"write_back_suspended_date": "2019-08-24T14:15:22Z",
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"images": ["string"
],
"tags": ["string"
],
"amazon_extra_info": "string",
"ebay_extra_info": ["string"
],
"etsy_extra_info": "string",
"shopify_extra_info": "string",
"square_extra_info": "string",
"squarespace_extra_info": "string",
"walmart_extra_info": "string",
"wayfair_extra_info": "string",
"audit_import": "string"
}

Put Product

Authorizations:

APIKey

Request Body schema: application/json

sku	string
name	string <= 1000 characters
category	string
hs_code	string <= 25 characters
m_pid	string <= 255 characters
ns_pid	string <= 255 characters
s_pid	string <= 255 characters
country_of_origin	string <= 100 characters
customs_description	string
declared_value	number
price	number
weight	number
length	integer
height	integer
width	integer
taxable	string <= 100 characters
cost	number
type	string <= 1000 characters
upc	string <= 100 characters
asin	string <= 10 characters
internal_notes	string
has_serial_numbers	string
is_digital	string
needs_order_line_labels	string
physical_on_hand	number
low_stock_threshold	number
out_of_stock_threshold	number
warehouses	Array of strings
location_in_warehouse	string <= 255 characters
cart	integer
sync	string
original_sku	string <= 255 characters
variant_sku	string <= 255 characters
inventory_changed	string
max_export_qty	integer
write_back_consecutive_failures	integer
write_back_suspended_date	string <date-time>
mo_internal_notes	string
mo_manufacturer_notes	string
images	Array of strings
tags	Array of strings
amazon_extra_info	string
ebay_extra_info	Array of strings
etsy_extra_info	string
shopify_extra_info	string
square_extra_info	string
squarespace_extra_info	string
walmart_extra_info	string
wayfair_extra_info	string
audit_import	string
min_export_qty	integer
refresh_label_info_customs	string
refresh_label_info_package	string
audit_export	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"category": "string",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "string",
"customs_description": "string",
"declared_value": 0,
"price": 0,
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"taxable": "string",
"cost": 0,
"type": "string",
"upc": "string",
"asin": "string",
"internal_notes": "string",
"has_serial_numbers": "string",
"is_digital": "string",
"needs_order_line_labels": "string",
"physical_on_hand": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"warehouses": ["string"
],
"location_in_warehouse": "string",
"cart": 0,
"sync": "string",
"original_sku": "string",
"variant_sku": "string",
"inventory_changed": "string",
"max_export_qty": 0,
"write_back_consecutive_failures": 0,
"write_back_suspended_date": "2019-08-24T14:15:22Z",
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"images": ["string"
],
"tags": ["string"
],
"amazon_extra_info": "string",
"ebay_extra_info": ["string"
],
"etsy_extra_info": "string",
"shopify_extra_info": "string",
"square_extra_info": "string",
"squarespace_extra_info": "string",
"walmart_extra_info": "string",
"wayfair_extra_info": "string",
"audit_import": "string",
"min_export_qty": 0,
"refresh_label_info_customs": "string",
"refresh_label_info_package": "string",
"audit_export": "string"
}

Get Product Count

Authorizations:

APIKey

Responses

Get Product Kit Graph

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
fba	string
fbm	string
category	Array of strings
hs_code	Array of strings
m_pid	Array of strings
ns_pid	Array of strings
s_pid	Array of strings
active	string
kit	string
kit_component	string
manufactured	string
manufacturing_component	string
dropship	string
needs_sync	string
inventory_sync_suspended	string
supplier	Array of integers[ items ]
no_supplier	string
sales_channel	Array of integers[ items ]
low_inventory_aoh	string
low_inventory_poh	string
to_be_shipped	string
oversold	string
reordered	string
overallocated	string
tag	Array of strings
untagged	string
exclude_tags	Array of strings
tag_filter_by	string
warehouse_id	Array of integers[ items ]
sku	Array of strings
product_type	string
fulfillment_type	Array of strings
updated_after	string <date-time>
updated_before	string <date-time>
barcode	Array of strings
stocktake_reference_id	string
cart	integer
components_type	string
descendants_only	string
include_inventory_quantities	string
translate_bom_skus	string

Responses

Delete Product Tag

Authorizations:

APIKey

Responses

Get Product Tag

Authorizations:

APIKey

query Parameters

limit	integer [ 1 .. 100 ] Default: 10
offset	integer Default: 0
id	Array of integers[ items ]

Responses

Response samples

Content type

application/json

{"count": 0,
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"limit": 10,
"offset": 0
}

Post Product Tag

Authorizations:

APIKey

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Product Tag

Authorizations:

APIKey

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Delete Product Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Get Product Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Post Product Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Product Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Get Product

Authorizations:

APIKey

path Parameters

sku

required

string

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
fba	string
fbm	string
category	Array of strings
hs_code	Array of strings
m_pid	Array of strings
ns_pid	Array of strings
s_pid	Array of strings
active	string
kit	string
kit_component	string
manufactured	string
manufacturing_component	string
dropship	string
needs_sync	string
inventory_sync_suspended	string
supplier	Array of integers[ items ]
no_supplier	string
sales_channel	Array of integers[ items ]
low_inventory_aoh	string
low_inventory_poh	string
to_be_shipped	string
oversold	string
reordered	string
overallocated	string
tag	Array of strings
untagged	string
exclude_tags	Array of strings
tag_filter_by	string
warehouse_id	Array of integers[ items ]
product_type	string
fulfillment_type	Array of strings
updated_after	string <date-time>
updated_before	string <date-time>
barcode	Array of strings
stocktake_reference_id	string
cart	integer

Responses

Head Product

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Post Product

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

sku	string
name	string <= 1000 characters
category	string
hs_code	string <= 25 characters
m_pid	string <= 255 characters
ns_pid	string <= 255 characters
s_pid	string <= 255 characters
country_of_origin	string <= 100 characters
customs_description	string
declared_value	number
price	number
weight	number
length	integer
height	integer
width	integer
taxable	string <= 100 characters
cost	number
type	string <= 1000 characters
upc	string <= 100 characters
asin	string <= 10 characters
internal_notes	string
has_serial_numbers	string
is_digital	string
needs_order_line_labels	string
physical_on_hand	number
low_stock_threshold	number
out_of_stock_threshold	number
warehouses	Array of strings
location_in_warehouse	string <= 255 characters
cart	integer
sync	string
original_sku	string <= 255 characters
variant_sku	string <= 255 characters
inventory_changed	string
max_export_qty	integer
write_back_consecutive_failures	integer
write_back_suspended_date	string <date-time>
mo_internal_notes	string
mo_manufacturer_notes	string
images	Array of strings
tags	Array of strings
amazon_extra_info	string
ebay_extra_info	Array of strings
etsy_extra_info	string
shopify_extra_info	string
square_extra_info	string
squarespace_extra_info	string
walmart_extra_info	string
wayfair_extra_info	string
audit_import	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"category": "string",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "string",
"customs_description": "string",
"declared_value": 0,
"price": 0,
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"taxable": "string",
"cost": 0,
"type": "string",
"upc": "string",
"asin": "string",
"internal_notes": "string",
"has_serial_numbers": "string",
"is_digital": "string",
"needs_order_line_labels": "string",
"physical_on_hand": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"warehouses": ["string"
],
"location_in_warehouse": "string",
"cart": 0,
"sync": "string",
"original_sku": "string",
"variant_sku": "string",
"inventory_changed": "string",
"max_export_qty": 0,
"write_back_consecutive_failures": 0,
"write_back_suspended_date": "2019-08-24T14:15:22Z",
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"images": ["string"
],
"tags": ["string"
],
"amazon_extra_info": "string",
"ebay_extra_info": ["string"
],
"etsy_extra_info": "string",
"shopify_extra_info": "string",
"square_extra_info": "string",
"squarespace_extra_info": "string",
"walmart_extra_info": "string",
"wayfair_extra_info": "string",
"audit_import": "string"
}

Put Product

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

sku	string
name	string <= 1000 characters
category	string
hs_code	string <= 25 characters
m_pid	string <= 255 characters
ns_pid	string <= 255 characters
s_pid	string <= 255 characters
country_of_origin	string <= 100 characters
customs_description	string
declared_value	number
price	number
weight	number
length	integer
height	integer
width	integer
taxable	string <= 100 characters
cost	number
type	string <= 1000 characters
upc	string <= 100 characters
asin	string <= 10 characters
internal_notes	string
has_serial_numbers	string
is_digital	string
needs_order_line_labels	string
physical_on_hand	number
low_stock_threshold	number
out_of_stock_threshold	number
warehouses	Array of strings
location_in_warehouse	string <= 255 characters
cart	integer
sync	string
original_sku	string <= 255 characters
variant_sku	string <= 255 characters
inventory_changed	string
max_export_qty	integer
write_back_consecutive_failures	integer
write_back_suspended_date	string <date-time>
mo_internal_notes	string
mo_manufacturer_notes	string
images	Array of strings
tags	Array of strings
amazon_extra_info	string
ebay_extra_info	Array of strings
etsy_extra_info	string
shopify_extra_info	string
square_extra_info	string
squarespace_extra_info	string
walmart_extra_info	string
wayfair_extra_info	string
audit_import	string
min_export_qty	integer
refresh_label_info_customs	string
refresh_label_info_package	string
audit_export	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"category": "string",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "string",
"customs_description": "string",
"declared_value": 0,
"price": 0,
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"taxable": "string",
"cost": 0,
"type": "string",
"upc": "string",
"asin": "string",
"internal_notes": "string",
"has_serial_numbers": "string",
"is_digital": "string",
"needs_order_line_labels": "string",
"physical_on_hand": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"warehouses": ["string"
],
"location_in_warehouse": "string",
"cart": 0,
"sync": "string",
"original_sku": "string",
"variant_sku": "string",
"inventory_changed": "string",
"max_export_qty": 0,
"write_back_consecutive_failures": 0,
"write_back_suspended_date": "2019-08-24T14:15:22Z",
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"images": ["string"
],
"tags": ["string"
],
"amazon_extra_info": "string",
"ebay_extra_info": ["string"
],
"etsy_extra_info": "string",
"shopify_extra_info": "string",
"square_extra_info": "string",
"squarespace_extra_info": "string",
"walmart_extra_info": "string",
"wayfair_extra_info": "string",
"audit_import": "string",
"min_export_qty": 0,
"refresh_label_info_customs": "string",
"refresh_label_info_package": "string",
"audit_export": "string"
}

Get Product

Authorizations:

APIKey

path Parameters

sku

required

string

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
fba	string
fbm	string
category	Array of strings
hs_code	Array of strings
m_pid	Array of strings
ns_pid	Array of strings
s_pid	Array of strings
active	string
kit	string
kit_component	string
manufactured	string
manufacturing_component	string
dropship	string
needs_sync	string
inventory_sync_suspended	string
supplier	Array of integers[ items ]
no_supplier	string
sales_channel	Array of integers[ items ]
low_inventory_aoh	string
low_inventory_poh	string
to_be_shipped	string
oversold	string
reordered	string
overallocated	string
tag	Array of strings
untagged	string
exclude_tags	Array of strings
tag_filter_by	string
warehouse_id	Array of integers[ items ]
product_type	string
fulfillment_type	Array of strings
updated_after	string <date-time>
updated_before	string <date-time>
barcode	Array of strings
stocktake_reference_id	string
cart	integer

Responses

Head Product

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Post Product

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

sku	string
name	string <= 1000 characters
category	string
hs_code	string <= 25 characters
m_pid	string <= 255 characters
ns_pid	string <= 255 characters
s_pid	string <= 255 characters
country_of_origin	string <= 100 characters
customs_description	string
declared_value	number
price	number
weight	number
length	integer
height	integer
width	integer
taxable	string <= 100 characters
cost	number
type	string <= 1000 characters
upc	string <= 100 characters
asin	string <= 10 characters
internal_notes	string
has_serial_numbers	string
is_digital	string
needs_order_line_labels	string
physical_on_hand	number
low_stock_threshold	number
out_of_stock_threshold	number
warehouses	Array of strings
location_in_warehouse	string <= 255 characters
cart	integer
sync	string
original_sku	string <= 255 characters
variant_sku	string <= 255 characters
inventory_changed	string
max_export_qty	integer
write_back_consecutive_failures	integer
write_back_suspended_date	string <date-time>
mo_internal_notes	string
mo_manufacturer_notes	string
images	Array of strings
tags	Array of strings
amazon_extra_info	string
ebay_extra_info	Array of strings
etsy_extra_info	string
shopify_extra_info	string
square_extra_info	string
squarespace_extra_info	string
walmart_extra_info	string
wayfair_extra_info	string
audit_import	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"category": "string",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "string",
"customs_description": "string",
"declared_value": 0,
"price": 0,
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"taxable": "string",
"cost": 0,
"type": "string",
"upc": "string",
"asin": "string",
"internal_notes": "string",
"has_serial_numbers": "string",
"is_digital": "string",
"needs_order_line_labels": "string",
"physical_on_hand": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"warehouses": ["string"
],
"location_in_warehouse": "string",
"cart": 0,
"sync": "string",
"original_sku": "string",
"variant_sku": "string",
"inventory_changed": "string",
"max_export_qty": 0,
"write_back_consecutive_failures": 0,
"write_back_suspended_date": "2019-08-24T14:15:22Z",
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"images": ["string"
],
"tags": ["string"
],
"amazon_extra_info": "string",
"ebay_extra_info": ["string"
],
"etsy_extra_info": "string",
"shopify_extra_info": "string",
"square_extra_info": "string",
"squarespace_extra_info": "string",
"walmart_extra_info": "string",
"wayfair_extra_info": "string",
"audit_import": "string"
}

Put Product

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

sku	string
name	string <= 1000 characters
category	string
hs_code	string <= 25 characters
m_pid	string <= 255 characters
ns_pid	string <= 255 characters
s_pid	string <= 255 characters
country_of_origin	string <= 100 characters
customs_description	string
declared_value	number
price	number
weight	number
length	integer
height	integer
width	integer
taxable	string <= 100 characters
cost	number
type	string <= 1000 characters
upc	string <= 100 characters
asin	string <= 10 characters
internal_notes	string
has_serial_numbers	string
is_digital	string
needs_order_line_labels	string
physical_on_hand	number
low_stock_threshold	number
out_of_stock_threshold	number
warehouses	Array of strings
location_in_warehouse	string <= 255 characters
cart	integer
sync	string
original_sku	string <= 255 characters
variant_sku	string <= 255 characters
inventory_changed	string
max_export_qty	integer
write_back_consecutive_failures	integer
write_back_suspended_date	string <date-time>
mo_internal_notes	string
mo_manufacturer_notes	string
images	Array of strings
tags	Array of strings
amazon_extra_info	string
ebay_extra_info	Array of strings
etsy_extra_info	string
shopify_extra_info	string
square_extra_info	string
squarespace_extra_info	string
walmart_extra_info	string
wayfair_extra_info	string
audit_import	string
min_export_qty	integer
refresh_label_info_customs	string
refresh_label_info_package	string
audit_export	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"category": "string",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "string",
"customs_description": "string",
"declared_value": 0,
"price": 0,
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"taxable": "string",
"cost": 0,
"type": "string",
"upc": "string",
"asin": "string",
"internal_notes": "string",
"has_serial_numbers": "string",
"is_digital": "string",
"needs_order_line_labels": "string",
"physical_on_hand": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"warehouses": ["string"
],
"location_in_warehouse": "string",
"cart": 0,
"sync": "string",
"original_sku": "string",
"variant_sku": "string",
"inventory_changed": "string",
"max_export_qty": 0,
"write_back_consecutive_failures": 0,
"write_back_suspended_date": "2019-08-24T14:15:22Z",
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"images": ["string"
],
"tags": ["string"
],
"amazon_extra_info": "string",
"ebay_extra_info": ["string"
],
"etsy_extra_info": "string",
"shopify_extra_info": "string",
"square_extra_info": "string",
"squarespace_extra_info": "string",
"walmart_extra_info": "string",
"wayfair_extra_info": "string",
"audit_import": "string",
"min_export_qty": 0,
"refresh_label_info_customs": "string",
"refresh_label_info_package": "string",
"audit_export": "string"
}

Post Product Archive

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Post Product Buy More

Authorizations:

APIKey

path Parameters

sku required	string
supplier_id required	integer

Request Body schema: application/json

warehouse required	integer
quantity required	integer
unit_price	number
discount_amount	number
po_id	string

Responses

Request samples

Payload

Content type

application/json

{"warehouse": 0,
"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"po_id": "string"
}

Get Product Cart

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

Responses

Head Product Cart

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

Responses

Post Product Cart

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

Responses

Put Product Cart

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

Request Body schema: application/json

sync	boolean
inventory_changed	boolean
reserve_export_qty	integer
percent_export_qty	integer
max_export_qty	integer or null
min_export_qty	integer or null
original_sku	string or null
variant_sku	string or null
audit_import	object
audit_export	object
write_back_consecutive_failures	integer
write_back_suspended_date	string or null <date-time>
	object (amazon_extra_info)
	object (walmart_extra_info)

Responses

Request samples

Payload

Content type

application/json

{"sync": true,
"inventory_changed": true,
"reserve_export_qty": 0,
"percent_export_qty": 0,
"max_export_qty": 0,
"min_export_qty": 0,
"original_sku": "string",
"variant_sku": "string",
"audit_import": { },
"audit_export": { },
"write_back_consecutive_failures": 0,
"write_back_suspended_date": "2019-08-24T14:15:22Z",
"amazon_extra_info": {"item_is_marketplace": "string",
"fulfillment_channel": "DEFAULT",
"fulfillment_latency": 0,
"pending_quantity": 0,
"listing_id": "string",
"asin": "string",
"item_condition": 0,
"category": "string",
"item_note": ""
},
"walmart_extra_info": {"fulfillment_latency": 0,
"wpid": "string"
}
}

Get Product Cart Extra Info

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string

Responses

Post Product Cart Extra Info

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

Responses

Put Product Cart Extra Info

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

Responses

Get Product Cart Extra Info

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer
extra_info_id required	integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string

Responses

Post Product Cart Extra Info

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer
extra_info_id required	integer

Responses

Put Product Cart Extra Info

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer
extra_info_id required	integer

Responses

Post Product Cart Image

Authorizations:

APIKey

path Parameters

sku required	string
cart_id required	integer

Request Body schema: application/json

	Array of objects (product_cart_image) [ items ]
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"images": [{"url": "string",
"is_default": true,
"cart_image_id": null
}
]
}

Delete Product Default Supplier

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Post Product Default Supplier

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Delete Product Default Supplier

Authorizations:

APIKey

path Parameters

sku required	string
supplier_id required	integer

Responses

Post Product Default Supplier

Authorizations:

APIKey

path Parameters

sku required	string
supplier_id required	integer

Responses

Put Product Fulfillment

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

fulfillment_type required	string Enum: "in_house" "dropshippable" "automatically_dropshipped"
default_supplier_id	integer

Responses

Request samples

Payload

Content type

application/json

{"fulfillment_type": "in_house",
"default_supplier_id": 0
}

Get Product Image

Authorizations:

APIKey

path Parameters

sku

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Post Product Image

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

One of

Array of objects (product_image) [ items ]

Responses

Request samples

Payload

Content type

application/json

Example

{"images": [{"url": "string",
"is_default": true
}
]
}

Put Product Image

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

is_default	boolean
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"is_default": true
}

Get Product Image

Authorizations:

APIKey

path Parameters

sku required	string
image_id required	integer

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Post Product Image

Authorizations:

APIKey

path Parameters

sku required	string
image_id required	integer

Request Body schema: application/json

One of

Array of objects (product_image) [ items ]

Responses

Request samples

Payload

Content type

application/json

Example

{"images": [{"url": "string",
"is_default": true
}
]
}

Put Product Image

Authorizations:

APIKey

path Parameters

sku required	string
image_id required	integer

Request Body schema: application/json

is_default	boolean
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"is_default": true
}

Delete Product Kit Component

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

_	string
child_sku required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"_": "string",
"child_sku": "string"
}

Post Product Kit Component

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

_	string
child_sku required	string non-empty
quantity	number >= 0.0001 Default: 1

Responses

Request samples

Payload

Content type

application/json

{"_": "string",
"child_sku": "string",
"quantity": 1
}

Put Product Kit Component

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

_	string
child_sku required	string non-empty
quantity required	number >= 0.0001

Responses

Request samples

Payload

Content type

application/json

{"_": "string",
"child_sku": "string",
"quantity": 0.0001
}

Get Product Kit Graph

Authorizations:

APIKey

path Parameters

sku

required

string

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
fba	string
fbm	string
category	Array of strings
hs_code	Array of strings
m_pid	Array of strings
ns_pid	Array of strings
s_pid	Array of strings
active	string
kit	string
kit_component	string
manufactured	string
manufacturing_component	string
dropship	string
needs_sync	string
inventory_sync_suspended	string
supplier	Array of integers[ items ]
no_supplier	string
sales_channel	Array of integers[ items ]
low_inventory_aoh	string
low_inventory_poh	string
to_be_shipped	string
oversold	string
reordered	string
overallocated	string
tag	Array of strings
untagged	string
exclude_tags	Array of strings
tag_filter_by	string
warehouse_id	Array of integers[ items ]
product_type	string
fulfillment_type	Array of strings
updated_after	string <date-time>
updated_before	string <date-time>
barcode	Array of strings
stocktake_reference_id	string
cart	integer
components_type	string
descendants_only	string
include_inventory_quantities	string
translate_bom_skus	string

Responses

Delete Product Manufacturing

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

child_sku

string

Responses

Request samples

Payload

Content type

application/json

{"child_sku": "string"
}

Get Product Manufacturing

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Post Product Manufacturing

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

child_sku	string
quantity	number

Responses

Request samples

Payload

Content type

application/json

{"child_sku": "string",
"quantity": 0
}

Put Product Manufacturing

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

child_sku	string
quantity	number

Responses

Request samples

Payload

Content type

application/json

{"child_sku": "string",
"quantity": 0
}

Delete Product Supplier

Authorizations:

APIKey

path Parameters

sku required	string
supplier_id required	integer

Responses

Put Product Supplier

Authorizations:

APIKey

path Parameters

sku required	string
supplier_id required	integer

Responses

Delete Product Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

sku required	string
name required	string

Responses

Post Product Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

sku required	string
name required	string

Responses

Post Product Unarchive

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Delete Product Warehouse

Authorizations:

APIKey

path Parameters

sku

required

string

Responses

Put Product Warehouse

Authorizations:

APIKey

path Parameters

sku

required

string

Request Body schema: application/json

physical_on_hand	number
adjustment	number
low_stock_threshold	number
out_of_stock_threshold	number
location_in_warehouse	string
comment	string

Responses

Request samples

Payload

Content type

application/json

{"physical_on_hand": 0,
"adjustment": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"location_in_warehouse": "string",
"comment": "string"
}

Delete Product Warehouse

Authorizations:

APIKey

path Parameters

sku required	string
warehouse_id required	integer

Responses

Put Product Warehouse

Authorizations:

APIKey

path Parameters

sku required	string
warehouse_id required	integer

Request Body schema: application/json

physical_on_hand	number
adjustment	number
low_stock_threshold	number
out_of_stock_threshold	number
location_in_warehouse	string
comment	string

Responses

Request samples

Payload

Content type

application/json

{"physical_on_hand": 0,
"adjustment": 0,
"low_stock_threshold": 0,
"out_of_stock_threshold": 0,
"location_in_warehouse": "string",
"comment": "string"
}

Put Product Warehouse Inventory

Authorizations:

APIKey

path Parameters

sku required	string
warehouse_id required	integer

Responses

Purchase Order

Delete Purchase Order Settings

Authorizations:

APIKey

Responses

Get Purchase Order Settings

Authorizations:

APIKey

Responses

Post Purchase Order Settings

Authorizations:

APIKey

Responses

Put Purchase Order Settings

Authorizations:

APIKey

Responses

Delete Purchase Order

Authorizations:

APIKey

Responses

Get Purchase Order

Authorizations:

APIKey

query Parameters

limit	integer Default: 100
offset	integer Default: 0
search	string
sort	Array of strings Items Enum: "status" "-status" "po_id" "-po_id" "updated" "-updated" "created" "-created" "supplier" "-supplier" "ship_to" "-ship_to" "sent" "-sent" "estimated_delivery_date" "-estimated_delivery_date"
status	Array of strings Items Enum: "all" "unsent" "sent" "partial" "received" "cancelled"
po_id	Array of strings
sku	Array of strings
warehouse_id	Array of integers[ items ]
supplier_id	Array of integers[ items ]
tag	Array of strings
untagged	boolean
tag_filter_by	string Enum: "or" "and" "only"
exclude_tags	Array of strings
id_only	boolean
start_date	string deprecated
end_date	string deprecated
timezone	string

Responses

Post Purchase Order

Authorizations:

APIKey

Request Body schema: application/json

supplier_id required	integer
warehouse_id	integer
po_id	string
shipping_method	string
payment_method	string
instructions	string
estimated_delivery_date	string
shipping_amount	number
tax_amount	number
discount_amount	number
	Array of objects (purchase_order_item) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"supplier_id": 0,
"warehouse_id": 0,
"po_id": "string",
"shipping_method": "string",
"payment_method": "string",
"instructions": "string",
"estimated_delivery_date": "string",
"shipping_amount": 0,
"tax_amount": 0,
"discount_amount": 0,
"items": [{"sku": "string",
"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"supplier_note": "string"
}
]
}

Put Purchase Order

Authorizations:

APIKey

Request Body schema: application/json

warehouse	integer
supplier	integer
po_id	string [ 1 .. 200 ] characters
shipping_method	string
instructions	string
sent	string <date-time>
estimated_delivery_date	string <date-time>
payment_method	string
discount_amount	number
shipping_amount	number
tax_amount	number
cancelled_date	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"warehouse": 0,
"supplier": 0,
"po_id": "string",
"shipping_method": "string",
"instructions": "string",
"sent": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z",
"payment_method": "string",
"discount_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"cancelled_date": "2019-08-24T14:15:22Z"
}

Get Purchase Order Count

Authorizations:

APIKey

Responses

Delete Purchase Order Tag

Authorizations:

APIKey

Responses

Get Purchase Order Tag

Authorizations:

APIKey

query Parameters

limit	integer [ 1 .. 100 ] Default: 10
offset	integer Default: 0
id	Array of integers[ items ]

Responses

Response samples

Content type

application/json

{"count": 0,
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"limit": 10,
"offset": 0
}

Post Purchase Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Purchase Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Delete Purchase Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Get Purchase Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Post Purchase Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Purchase Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Delete Purchase Order

Authorizations:

APIKey

path Parameters

po_id

required

string

Responses

Get Purchase Order

Authorizations:

APIKey

path Parameters

po_id

required

string

Responses

Post Purchase Order

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

supplier_id required	integer
warehouse_id	integer
po_id	string
shipping_method	string
payment_method	string
instructions	string
estimated_delivery_date	string
shipping_amount	number
tax_amount	number
discount_amount	number
	Array of objects (purchase_order_item) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"supplier_id": 0,
"warehouse_id": 0,
"po_id": "string",
"shipping_method": "string",
"payment_method": "string",
"instructions": "string",
"estimated_delivery_date": "string",
"shipping_amount": 0,
"tax_amount": 0,
"discount_amount": 0,
"items": [{"sku": "string",
"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"supplier_note": "string"
}
]
}

Put Purchase Order

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

warehouse	integer
supplier	integer
po_id	string [ 1 .. 200 ] characters
shipping_method	string
instructions	string
sent	string <date-time>
estimated_delivery_date	string <date-time>
payment_method	string
discount_amount	number
shipping_amount	number
tax_amount	number
cancelled_date	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"warehouse": 0,
"supplier": 0,
"po_id": "string",
"shipping_method": "string",
"instructions": "string",
"sent": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z",
"payment_method": "string",
"discount_amount": 0,
"shipping_amount": 0,
"tax_amount": 0,
"cancelled_date": "2019-08-24T14:15:22Z"
}

Post Purchase Order Cancel

Authorizations:

APIKey

path Parameters

po_id

required

string

Responses

Get Purchase Order Comment

Authorizations:

APIKey

path Parameters

po_id

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 35,
"limit": 1,
"offset": 0,
"comment": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Purchase Order Comment

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}

Post Purchase Order Create Goods Receipt

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

goods_receipt_id	string <= 300 characters
internal_notes	string

Responses

Request samples

Payload

Content type

application/json

{"goods_receipt_id": "string",
"internal_notes": "string"
}

Delete Purchase Order Line

Authorizations:

APIKey

path Parameters

po_id

required

string

Responses

Post Purchase Order Line

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

sku	string
quantity	integer
unit_price	number
discount_amount	number
supplier_note	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"supplier_note": "string"
}

Put Purchase Order Line

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

quantity	integer
unit_price	number
discount_amount	number
supplier_note	string

Responses

Request samples

Payload

Content type

application/json

{"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"supplier_note": "string"
}

Delete Purchase Order Line

Authorizations:

APIKey

path Parameters

po_id required	string
po_item_id required	integer

Responses

Post Purchase Order Line

Authorizations:

APIKey

path Parameters

po_id required	string
po_item_id required	integer

Request Body schema: application/json

sku	string
quantity	integer
unit_price	number
discount_amount	number
supplier_note	string

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"supplier_note": "string"
}

Put Purchase Order Line

Authorizations:

APIKey

path Parameters

po_id required	string
po_item_id required	integer

Request Body schema: application/json

quantity	integer
unit_price	number
discount_amount	number
supplier_note	string

Responses

Request samples

Payload

Content type

application/json

{"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"supplier_note": "string"
}

Get Purchase Order Send

Authorizations:

APIKey

path Parameters

po_id

required

string

query Parameters

show_images	boolean Default: false
show_supplier_note	boolean Default: false

Responses

Post Purchase Order Send

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

show_images	boolean Default: false
show_supplier_note	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"show_images": false,
"show_supplier_note": false
}

Put Purchase Order Item Sort

Authorizations:

APIKey

path Parameters

po_id

required

string

Request Body schema: application/json

poi_ids

required

Array of integers[ items ]

Responses

Request samples

Payload

Content type

application/json

{"poi_ids": [0
]
}

Response samples

Content type

application/json

{"status": "string",
"company_id": 0,
"po_id": "string",
"shipping_method": "string",
"payment_method": "string",
"instructions": "string",
"sent": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"cancelled_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"shipping_amount": 0,
"tax_amount": 0,
"discount_amount": 0,
"_link": "string",
"items": [{"id": 0,
"quantity": 0,
"unit_price": 0,
"discount_amount": 0,
"_link": "string",
"product": {"type": "Tangible",
"cost": 4.95,
"id": 19551105,
"company_id": 1985,
"name": "Flux Capacitor",
"sku": "outa-time",
"taxable": "string",
"weight": 1.21,
"length": 12,
"width": 4,
"height": 8,
"price": 19.55,
"customer_text": "string",
"internal_notes": "Be sure to include the complimentary almanac",
"total_on_hand": 0,
"category": "misc-timetravel",
"is_kit_parent": false,
"archive_date": "2019-08-24T14:15:22Z",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "US",
"customs_description": "string",
"created": "2020-10-26T15:44:17.993588-06:00",
"updated": "2026-01-01T17:54:05.158248-06:00",
"upc": "847509005811",
"asin": "B07WXJHZ1L",
"image_url": "string",
"default_image_id": 0,
"_link": "string",
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"total_committed": 0,
"total_available": 0,
"total_allocated": 0,
"total_unallocated": 0,
"po_total_committed": 0,
"available_on_hand": 0,
"declared_value": 0,
"has_serial_numbers": false,
"linked_skus": [{ }
],
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"on_pos": 0,
"to_be_shipped": 0,
"total_mfg_ordered": 0,
"total_physical_on_hand": 0,
"total_po_committed": 0,
"fulfillment_type": "in_house",
"supplier": {"sku": "string",
"price": 0,
"unit_price": 0
},
"warehouse": {"location_in_warehouse": "string"
}
},
"to_be_shipped": 0,
"available_on_hand": 0,
"quantity_received": 0
}
],
"supplier": {"id": 0,
"_link": "string",
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"archive_date": "2019-08-24T14:15:22Z",
"automatically_show_ship_to_email": true,
"automatically_show_supplier_price": true,
"automatically_show_images_email": true,
"automatically_show_images_packing_list": true,
"automatically_show_customer_notes_email": true,
"automatically_include_digital_products": true,
"company_id": 0,
"created": "2019-08-24T14:15:22Z",
"default_shipping_account": "string",
"default_shipping_carrier": "string",
"default_shipping_method": "string",
"dropship_prefer_cart_order_line_names": true,
"dropshipment_sender_contact_id": 0,
"dropshipment_routing_contact_id": 0,
"dropshipment_routing_address": "string",
"dropshipment_routing_channel": "string",
"po_sender_contact_id": 0,
"po_routing_contact_id": 0,
"po_routing_address": "string",
"po_routing_channel": "string",
"shipping_method_maps": [{"active": true,
"created": "string",
"id": 0,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string",
"supplier_id": 0,
"updated": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"vendor_config": { },
"warehouse_id": 0
},
"warehouse": {"_link": "string",
"created_date": "2019-08-24T14:15:22Z",
"id": 0,
"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"cart": "string",
"is_configured_for_shipping": true,
"is_default_location": true,
"updated_date": "2019-08-24T14:15:22Z",
"warehouse_name": "string"
},
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"goods_receipts": [{"status": "string",
"po_id": "string",
"po_status": "string",
"goods_receipt_id": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"received": "2019-08-24T14:15:22Z",
"_link": "string",
"internal_notes": "string",
"items": [{"id": 0,
"po_item_id": 0,
"quantity": 0,
"_link": "string",
"product": {"type": "Tangible",
"cost": 4.95,
"id": 19551105,
"company_id": 1985,
"name": "Flux Capacitor",
"sku": "outa-time",
"taxable": "string",
"weight": 1.21,
"length": 12,
"width": 4,
"height": 8,
"price": 19.55,
"customer_text": "string",
"internal_notes": "Be sure to include the complimentary almanac",
"total_on_hand": 0,
"category": "misc-timetravel",
"is_kit_parent": false,
"archive_date": "2019-08-24T14:15:22Z",
"hs_code": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string",
"country_of_origin": "US",
"customs_description": "string",
"created": "2020-10-26T15:44:17.993588-06:00",
"updated": "2026-01-01T17:54:05.158248-06:00",
"upc": "847509005811",
"asin": "B07WXJHZ1L",
"image_url": "string",
"default_image_id": 0,
"_link": "string",
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
],
"total_committed": 0,
"total_available": 0,
"total_allocated": 0,
"total_unallocated": 0,
"po_total_committed": 0,
"available_on_hand": 0,
"declared_value": 0,
"has_serial_numbers": false,
"linked_skus": [{ }
],
"mo_internal_notes": "string",
"mo_manufacturer_notes": "string",
"on_pos": 0,
"to_be_shipped": 0,
"total_mfg_ordered": 0,
"total_physical_on_hand": 0,
"total_po_committed": 0,
"fulfillment_type": "in_house"
}
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Delete Purchase Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

po_id required	string
po_tag_name required	string

Responses

Post Purchase Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

po_id required	string
po_tag_name required	string

Responses

Post Purchase Order Uncancel

Authorizations:

APIKey

path Parameters

po_id

required

string

Responses

Rate V3

Post All Rate Controller Marketing

Request Body schema: application/json

required	object
from_zip required	string ZIP code from which you are shipping
to_zip required	string ZIP code to which you are shipping
additional_package_options	object
additional_rate_options	object
recaptcha_token required	string

Responses

Request samples

Payload

Content type

application/json

{"package": {"height": 0,
"length": 0,
"weight": 0,
"width": 0
},
"from_zip": "string",
"to_zip": "string",
"additional_package_options": { },
"additional_rate_options": { },
"recaptcha_token": "string"
}

Report

Delete Report Alert Low Inventory

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Get Report Alert Low Inventory

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Post Report Alert Low Inventory

Authorizations:

APIKey

Request Body schema: application/json

frequency	string Enum: "weekly" "daily" "hourly" The frequency the task will run
to_emails	Array of strings
include_kit_skus	boolean

Responses

Request samples

Payload

Content type

application/json

{"frequency": "weekly",
"to_emails": ["string"
],
"include_kit_skus": true
}

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Delete Report

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Get Report

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
type	string
sort	string Enum: "type" "-type" "name" "-name" "created_date" "-created_date" "updated_date" "-updated_date"

Responses

Response samples

Content type

application/json

{"limit": 10,
"offset": 0,
"count": 0,
"report": [{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Post Report

Authorizations:

APIKey

Request Body schema: application/json

name	string
type required	string Enum: "aoh_report" "cart_inventory_report" "component_inventory_value_report" "custom_reporter" "failed_tracking_report" "fulfillment_speed_report" "high_order_value_report" "inventory_report" "inventory_snapshot" "inventory_supplier_info_report" "kit_inventory_report" "kit_structure_report" "low_inventory_report" "non_supplied_products_report" "parameterized_report" "sales_forecasting_report" "sales_per_sku_report" "export_products" "export_products_inventory" "export_products_no_inventory" "export_products_suppliers" "export_shipments" "export_orders" "export_shipped_orders" "export_inventory_log" "export_billing_insurance" "export_postage_account" "export_purchase_order_summary" "export_purchase_order_detail" "export_goods_receipt" "export_sku_sales" "export_rma_summary" "export_rma_detail" "export_products_sales_channels" "export_mo_summary" "export_mo_detail" "export_bom_inventory" "export_bom_structure" "export_delivery_status_summary" "export_delivery_status_detail" "export_products_fulfillment_speed" "export_fulfillment_speed"
params required	object
to_emails	Array of strings
delivery_method	string or null
is_alert	boolean
subject	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "aoh_report",
"params": { },
"to_emails": ["string"
],
"delivery_method": "string",
"is_alert": true,
"subject": "string"
}

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Put Report

Authorizations:

APIKey

Request Body schema: application/json

name	string
params	object
to_emails	Array of strings
delivery_method	string or null
is_alert	boolean
subject	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"params": { },
"to_emails": ["string"
],
"delivery_method": "string",
"is_alert": true,
"subject": "string"
}

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Delete Report Schedule

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"limit": 10,
"offset": 0,
"count": 0,
"report_schedule": [{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Get Report Schedule

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
report_id	Array of integers[ items ]
frequency	string Value: "daily"
active	boolean

Responses

Response samples

Content type

application/json

Example

report_schedule_list

{"limit": 10,
"offset": 0,
"count": 0,
"report_schedule": [{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Post Report Schedule

Authorizations:

APIKey

Request Body schema: application/json

frequency	string Enum: "weekly" "daily" "hourly" "monthly" The frequency the task will run
to_emails	Array of strings
active	boolean Whether or not the schedule is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "weekly",
"to_emails": ["string"
],
"active": true
}

Response samples

Content type

application/json

{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}

Put Report Schedule

Authorizations:

APIKey

Request Body schema: application/json

frequency	string Enum: "weekly" "daily" "hourly" "monthly" The frequency the task will run
to_emails	Array of strings
active	boolean Whether or not the schedule is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "weekly",
"to_emails": ["string"
],
"active": true
}

Response samples

Content type

application/json

{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}

Delete Report

Authorizations:

APIKey

path Parameters

report_id

required

integer

Responses

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Get Report

Authorizations:

APIKey

path Parameters

report_id

required

integer

Responses

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Post Report

Authorizations:

APIKey

path Parameters

report_id

required

integer

Request Body schema: application/json

name	string
type required	string Enum: "aoh_report" "cart_inventory_report" "component_inventory_value_report" "custom_reporter" "failed_tracking_report" "fulfillment_speed_report" "high_order_value_report" "inventory_report" "inventory_snapshot" "inventory_supplier_info_report" "kit_inventory_report" "kit_structure_report" "low_inventory_report" "non_supplied_products_report" "parameterized_report" "sales_forecasting_report" "sales_per_sku_report" "export_products" "export_products_inventory" "export_products_no_inventory" "export_products_suppliers" "export_shipments" "export_orders" "export_shipped_orders" "export_inventory_log" "export_billing_insurance" "export_postage_account" "export_purchase_order_summary" "export_purchase_order_detail" "export_goods_receipt" "export_sku_sales" "export_rma_summary" "export_rma_detail" "export_products_sales_channels" "export_mo_summary" "export_mo_detail" "export_bom_inventory" "export_bom_structure" "export_delivery_status_summary" "export_delivery_status_detail" "export_products_fulfillment_speed" "export_fulfillment_speed"
params required	object
to_emails	Array of strings
delivery_method	string or null
is_alert	boolean
subject	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "aoh_report",
"params": { },
"to_emails": ["string"
],
"delivery_method": "string",
"is_alert": true,
"subject": "string"
}

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Put Report

Authorizations:

APIKey

path Parameters

report_id

required

integer

Request Body schema: application/json

name	string
params	object
to_emails	Array of strings
delivery_method	string or null
is_alert	boolean
subject	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"params": { },
"to_emails": ["string"
],
"delivery_method": "string",
"is_alert": true,
"subject": "string"
}

Response samples

Content type

application/json

{"name": "string",
"type": "string",
"params": { },
"id": 0,
"is_alert": true,
"link": "string",
"log_link": "string",
"created_date": "string",
"updated_date": "string"
}

Get Report Run

Authorizations:

APIKey

path Parameters

report_id

required

integer

query Parameters

limit	integer Default: 10
offset	integer Default: 0
sort	string Enum: "created" "-created" "updated" "-updated" "complete" "-complete" "success" "-success"

Responses

Response samples

Content type

application/json

{"limit": 10,
"offset": 0,
"count": 0,
"report_run": [{"id": 0,
"params": { },
"complete": true,
"success": true,
"created": "string",
"updated": "string",
"creator": "string",
"csv_link": "string"
}
]
}

Post Report Run

Authorizations:

APIKey

path Parameters

report_id

required

integer

Request Body schema: application/json

delivery_method	string Value: "email"
to_emails	Array of strings
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"delivery_method": "email",
"to_emails": ["string"
]
}

Response samples

Content type

application/json

{"id": 0,
"params": { },
"complete": true,
"success": true,
"created": "string",
"updated": "string",
"creator": "string",
"csv_link": "string"
}

Put Report Run

Authorizations:

APIKey

path Parameters

report_id

required

integer

Request Body schema: application/json

complete	boolean
success	boolean
s3_key	string
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"complete": true,
"success": true,
"s3_key": "string"
}

Response samples

Content type

application/json

{"id": 0,
"params": { },
"complete": true,
"success": true,
"created": "string",
"updated": "string",
"creator": "string",
"csv_link": "string"
}

Get Report Run

Authorizations:

APIKey

path Parameters

report_id required	integer
run_id required	integer

Responses

Response samples

Content type

application/json

{"id": 0,
"params": { },
"complete": true,
"success": true,
"created": "string",
"updated": "string",
"creator": "string",
"csv_link": "string"
}

Post Report Run

Authorizations:

APIKey

path Parameters

report_id required	integer
run_id required	integer

Request Body schema: application/json

delivery_method	string Value: "email"
to_emails	Array of strings
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"delivery_method": "email",
"to_emails": ["string"
]
}

Response samples

Content type

application/json

{"id": 0,
"params": { },
"complete": true,
"success": true,
"created": "string",
"updated": "string",
"creator": "string",
"csv_link": "string"
}

Put Report Run

Authorizations:

APIKey

path Parameters

report_id required	integer
run_id required	integer

Request Body schema: application/json

complete	boolean
success	boolean
s3_key	string
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"complete": true,
"success": true,
"s3_key": "string"
}

Response samples

Content type

application/json

{"id": 0,
"params": { },
"complete": true,
"success": true,
"created": "string",
"updated": "string",
"creator": "string",
"csv_link": "string"
}

Delete Report Schedule

Authorizations:

APIKey

path Parameters

report_id

required

integer

Responses

Response samples

Content type

application/json

{"limit": 10,
"offset": 0,
"count": 0,
"report_schedule": [{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Get Report Schedule

Authorizations:

APIKey

path Parameters

report_id

required

integer

query Parameters

limit	integer Default: 10
offset	integer Default: 0
frequency	string Value: "daily"
active	boolean

Responses

Response samples

Content type

application/json

Example

report_schedule_list

{"limit": 10,
"offset": 0,
"count": 0,
"report_schedule": [{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Post Report Schedule

Authorizations:

APIKey

path Parameters

report_id

required

integer

Request Body schema: application/json

frequency	string Enum: "weekly" "daily" "hourly" "monthly" The frequency the task will run
to_emails	Array of strings
active	boolean Whether or not the schedule is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "weekly",
"to_emails": ["string"
],
"active": true
}

Response samples

Content type

application/json

{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}

Put Report Schedule

Authorizations:

APIKey

path Parameters

report_id

required

integer

Request Body schema: application/json

frequency	string Enum: "weekly" "daily" "hourly" "monthly" The frequency the task will run
to_emails	Array of strings
active	boolean Whether or not the schedule is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "weekly",
"to_emails": ["string"
],
"active": true
}

Response samples

Content type

application/json

{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}

Delete Report Schedule

Authorizations:

APIKey

path Parameters

report_id required	integer
report_schedule_id required	integer

Responses

Response samples

Content type

application/json

{"limit": 10,
"offset": 0,
"count": 0,
"report_schedule": [{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Get Report Schedule

Authorizations:

APIKey

path Parameters

report_id required	integer
report_schedule_id required	integer

query Parameters

limit	integer Default: 10
offset	integer Default: 0
frequency	string Value: "daily"
active	boolean

Responses

Response samples

Content type

application/json

Example

report_schedule_list

{"limit": 10,
"offset": 0,
"count": 0,
"report_schedule": [{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}
]
}

Post Report Schedule

Authorizations:

APIKey

path Parameters

report_id required	integer
report_schedule_id required	integer

Request Body schema: application/json

frequency	string Enum: "weekly" "daily" "hourly" "monthly" The frequency the task will run
to_emails	Array of strings
active	boolean Whether or not the schedule is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "weekly",
"to_emails": ["string"
],
"active": true
}

Response samples

Content type

application/json

{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}

Put Report Schedule

Authorizations:

APIKey

path Parameters

report_id required	integer
report_schedule_id required	integer

Request Body schema: application/json

frequency	string Enum: "weekly" "daily" "hourly" "monthly" The frequency the task will run
to_emails	Array of strings
active	boolean Whether or not the schedule is active

Responses

Request samples

Payload

Content type

application/json

{"frequency": "weekly",
"to_emails": ["string"
],
"active": true
}

Response samples

Content type

application/json

{"id": 0,
"frequency": "weekly",
"report_id": 0,
"to_emails": ["string"
],
"active": true,
"_link": "string",
"created_date": "string",
"updated_date": "string"
}

Return Label

Get Return Label

Authorizations:

APIKey

query Parameters

s	Array of integers[ items ]
type	string
default	string
page_width	number
page_height	number
orientation	string
top_margin	number
left_margin	number
width	number
height	number
rotation	string

Responses

Get Return Label P D F

Authorizations:

APIKey

query Parameters

s	Array of integers[ items ]
type	string
default	string
page_width	number
page_height	number
orientation	string
top_margin	number
left_margin	number
width	number
height	number
rotation	string

Responses

Get Return Label Raw

Authorizations:

APIKey

path Parameters

label_id

required

integer

Responses

Return Order

Get Return Order

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
search	string
status	string
tag	Array of strings
untagged	boolean
tag_filter_by	string Enum: "or" "and" "only" "not"
reference_id	Array of strings
sort	string Enum: "reference_id" "-reference_id" "status" "-status" "warehouse_name" "-warehouse_name" "created_date" "-created_date" "updated_date" "-updated_date"

Responses

Response samples

Content type

application/json

{"limit": 10,
"offset": 0,
"count": 0,
"return_order": [{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}
]
}

Post Return Order

Authorizations:

APIKey

Request Body schema: application/json

reference_id required	string
original_order_number	string
warehouse_id	integer
required	object (v1_address)
	object (v1_address)
customer_notes	string
internal_notes	string
required	Array of objects[ items ]

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"warehouse_id": 0,
"customer_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customer_notes": "string",
"internal_notes": "string",
"lines": [{"sku": "string",
"expected_quantity": 0
}
]
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Put Return Order

Authorizations:

APIKey

Request Body schema: application/json

status	string Enum: "initiated" "active" "finished" "cancelled"
customer_notes	string
internal_notes	string
warehouse_id	integer
	object (v1_address)
	object (v1_address)

Responses

Request samples

Payload

Content type

application/json

{"status": "initiated",
"customer_notes": "string",
"internal_notes": "string",
"warehouse_id": 0,
"customer_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
}
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Delete Return Order Code

Authorizations:

APIKey

Responses

Get Return Order Code

Authorizations:

APIKey

query Parameters

limit	integer [ 1 .. 100 ] Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 0,
"code": [{"code": "string",
"description": "string"
}
],
"limit": 10,
"offset": 0
}

Post Return Order Code

Authorizations:

APIKey

Request Body schema: application/json

code required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Put Return Order Code

Authorizations:

APIKey

Request Body schema: application/json

code	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Delete Return Order Code

Authorizations:

APIKey

path Parameters

code

required

string

Responses

Get Return Order Code

Authorizations:

APIKey

path Parameters

code

required

string

Responses

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Post Return Order Code

Authorizations:

APIKey

path Parameters

code

required

string

Request Body schema: application/json

code required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Put Return Order Code

Authorizations:

APIKey

path Parameters

code

required

string

Request Body schema: application/json

code	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Get Return Order Counts

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"all": 0,
"active": 0,
"cancelled": 0,
"finished": 0,
"initiated": 0
}

Delete Return Order Tag

Authorizations:

APIKey

Responses

Get Return Order Tag

Authorizations:

APIKey

query Parameters

limit	integer [ 1 .. 100 ] Default: 10
offset	integer Default: 0
id	Array of integers[ items ]

Responses

Response samples

Content type

application/json

{"count": 0,
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"limit": 10,
"offset": 0
}

Post Return Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Return Order Tag

Authorizations:

APIKey

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Delete Return Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Get Return Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Post Return Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Return Order Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Get Return Order

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Post Return Order

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

reference_id required	string
original_order_number	string
warehouse_id	integer
required	object (v1_address)
	object (v1_address)
customer_notes	string
internal_notes	string
required	Array of objects[ items ]

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"warehouse_id": 0,
"customer_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customer_notes": "string",
"internal_notes": "string",
"lines": [{"sku": "string",
"expected_quantity": 0
}
]
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Put Return Order

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

status	string Enum: "initiated" "active" "finished" "cancelled"
customer_notes	string
internal_notes	string
warehouse_id	integer
	object (v1_address)
	object (v1_address)

Responses

Request samples

Payload

Content type

application/json

{"status": "initiated",
"customer_notes": "string",
"internal_notes": "string",
"warehouse_id": 0,
"customer_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
}
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Get Return Order Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 35,
"limit": 1,
"offset": 0,
"comment": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Return Order Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}

Post Return Order Email

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

packing_list_id

number

Responses

Request samples

Payload

Content type

application/json

{"packing_list_id": 0
}

Get Return Order Label Info

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Delete Return Order Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Post Return Order Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

sku required	string
	null or string
restock_warehouse_id	integer or null
line_notes	string or null
total_price	number
expected_quantity required	number
product_serial_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"product_serial_numbers": ["string"
]
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Put Return Order Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

	null or string
restock_warehouse_id	integer or null
line_notes	string or null
total_price	number
expected_quantity	number
received_quantity	number
restocked_quantity	number
product_serial_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0,
"product_serial_numbers": ["string"
]
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Delete Return Order Line

Authorizations:

APIKey

path Parameters

reference_id required	string
return_order_line_id required	integer

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Post Return Order Line

Authorizations:

APIKey

path Parameters

reference_id required	string
return_order_line_id required	integer

Request Body schema: application/json

sku required	string
	null or string
restock_warehouse_id	integer or null
line_notes	string or null
total_price	number
expected_quantity required	number
product_serial_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"product_serial_numbers": ["string"
]
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Put Return Order Line

Authorizations:

APIKey

path Parameters

reference_id required	string
return_order_line_id required	integer

Request Body schema: application/json

	null or string
restock_warehouse_id	integer or null
line_notes	string or null
total_price	number
expected_quantity	number
received_quantity	number
restocked_quantity	number
product_serial_numbers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0,
"product_serial_numbers": ["string"
]
}

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Post Return Order Preset

Authorizations:

APIKey

path Parameters

reference_id required	string
preset_id required	integer

Responses

Response samples

Content type

application/json

{"presets": [0
]
}

Delete Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Get Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

tracking_number required	string
package_tracking	string
cost	number
ship_date required	string <date-time>
display_shipping_method	string
shipping_cost	number
shipping_method	string
carrier_name required	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
notify_cart	boolean Default: false
tracking_url	string
zone	string or null

Responses

Request samples

Payload

Content type

application/json

{"tracking_number": "string",
"package_tracking": "string",
"cost": 0,
"ship_date": "2019-08-24T14:15:22Z",
"display_shipping_method": "string",
"shipping_cost": 0,
"shipping_method": "string",
"carrier_name": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"notify_cart": false,
"tracking_url": "string",
"zone": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Put Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Delete Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id required	string
shipping_info_id required	integer

Responses

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Get Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id required	string
shipping_info_id required	integer

Responses

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id required	string
shipping_info_id required	integer

Request Body schema: application/json

tracking_number required	string
package_tracking	string
cost	number
ship_date required	string <date-time>
display_shipping_method	string
shipping_cost	number
shipping_method	string
carrier_name required	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
notify_cart	boolean Default: false
tracking_url	string
zone	string or null

Responses

Request samples

Payload

Content type

application/json

{"tracking_number": "string",
"package_tracking": "string",
"cost": 0,
"ship_date": "2019-08-24T14:15:22Z",
"display_shipping_method": "string",
"shipping_cost": 0,
"shipping_method": "string",
"carrier_name": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"notify_cart": false,
"tracking_url": "string",
"zone": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Put Return Order Shipping Info

Authorizations:

APIKey

path Parameters

reference_id required	string
shipping_info_id required	integer

Responses

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Delete Return Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

reference_id required	string
name required	string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Post Return Order Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

reference_id required	string
name required	string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Get Return Order Shipper Tracking

Authorizations:

APIKey

path Parameters

shipper_id required	integer
tracking_number required	string

query Parameters

void	boolean Default: false

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"original_order_number": "string",
"status": "string",
"customer_address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"return_to_address": null,
"warehouse_id": 0,
"customer_notes": "string",
"internal_notes": "string",
"has_shipping_info": true,
"label_infos": [0
],
"lines": [{"line_id": 0,
"sku": "string",
"product_name": "string",
"product_serial_numbers": ["string"
],
"code": null,
"restock_warehouse_id": 0,
"line_notes": "string",
"total_price": 0,
"expected_quantity": 0,
"received_quantity": 0,
"restocked_quantity": 0
}
],
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"created_date": "string",
"shipping_infos": [{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}
],
"updated_date": "string"
}

Return Order Label

Post Return Order Label Australia Post

Authorizations:

APIKey

Request Body schema: application/json

box_shape	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string
insurance_type	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
required	Array of objects <= 200 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
reason_for_export	string
reference_id	string Identifier for a Return Order
reference_number	string Package level reference, not always necessarily a number
return	boolean
service_token	string token for rate type received for a specific shipment, required if shipment_id is included
ship_date	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipment_id	string id of shipment created by easypost
shipper_id required	integer
shipping_method	string Service type: unused if shipment_id and service_token are present.

Responses

Request samples

Payload

Content type

application/json

{"box_shape": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"insurance_type": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"additional_handling": true,
"box_shape": "string",
"height": 0,
"length": 0,
"reference_number": "string",
"reference": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"reason_for_export": "string",
"reference_id": "string",
"reference_number": "string",
"return": true,
"service_token": "string",
"ship_date": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipment_id": "string",
"shipper_id": 0,
"shipping_method": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label Canada Post

Authorizations:

APIKey

Request Body schema: application/json

shipper_type	string unused with maryann carrier implementation
shipper_id required	integer
shipping_method required	string Domestic - [DOM.RP - Regular Parcel, DOM.EP - Expedited Parcel, DOM.XP - Xpresspost, DOM.PC - Priority], USA - [USA.PW.ENV - Priority Worldwide Envelope USA, USA.PW.PAK - Priority Worldwide pak USA, USA.PW.PARCEL - Priority Worldwide Parcel USA, USA.XP - Xpresspost USA, USA.EP - Expedited Parcel USA, USA.SP.AIR - Small Packet USA Air, USA.TP - Tracked Packet - USA], International - [INT.IP.AIR - International Parcel Air, INT.IP.SURF International Parcel Surface, INT.PW.ENV - Priority Worldwide Envelope Int'l, INT.PW.PAK - Priority Worldwide pak Int'l, INT.PW.PARCEL - Priority Worldwide parcel Int'l, INT.XP - Xpresspost International, INT.SP.AIR - Small Packet International Air, INT.SP.SURF - Small Packet International Surface, INT.TP - Tracked Packet - International]
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
reference_id	string Identifier for a Return Order
reference_number	string Customer supplied internal reference for the order
reason_for_export	string Enum: "SOG" "DOC" "SAM" "REP" "OTH"
nondelivery_option	string Enum: "RASE" "RTS" "ABAN"
delivery_confirmation	string Enum: "SO" "PA18" "PA19"
service_option	string
insurance_type	string Value: "canada_post"
insured_value	number Default: 0
invoice_number	string <= 10 characters Used for customs information: If required by customs at the destination, the commercial invoice number.
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
return	boolean
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"shipper_type": "string",
"shipper_id": 0,
"shipping_method": "string",
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"box_shape": "Parcel",
"length": 0,
"width": 0,
"height": 0,
"weight": 0
}
],
"packing_list_id": 0,
"reference_id": "string",
"reference_number": "string",
"reason_for_export": "SOG",
"nondelivery_option": "RASE",
"delivery_confirmation": "SO",
"service_option": "string",
"insurance_type": "canada_post",
"insured_value": 0,
"invoice_number": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return": true,
"warehouse_id": 0
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label D H L

Authorizations:

APIKey

Request Body schema: application/json

shipper_id required	integer
weight	number Weight in ounces
length	integer Length in inches
width	integer Width in inches
height	integer Height in inches
box_shape	string Enum: "FLY" "COY" "NCY" "PAL" "DBL" "BOX" optional box type [FLY=Flyer/Smalls - pieces that are too small, thin or light to be sorted on a standard conveyor, or for which it makes sense to group pieces into larger units for sort purposes. COY=Parcels/Conveyables - pieces that can be handled onto a system, less than 31.5 kg and up to 6060120cm. NCY=Non-conveyables - Pieces that cannot on their own be sorted on standard conveyor. PAL=Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. DBL=Double Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. BOX=Parcels that are conveyable have the shape of a box. Up to 70kg.]
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
reason_for_export	string Default: "P" [P - Permanent, T - Temporary, R - Re-Export] It is required for dutiable shipment.
reason_for_export_explanation	string
declared_value	number Shipment Level Declared Value for Dutiable International Shipments
insured_value	number
insurance_type	string Value: "dhl"
shipping_method required	string (dhl_service_types) Enum: "0" "1" "2" "3" "4" "5" "7" "8" "9" "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z" options: [0 - LOGISTICS SERVICES, 1 - DOMESTIC EXPRESS 12:00, 2 - B2C, 3 - B2C, 4 - JETLINE, 5 - SPRINTLINE, 7 - EXPRESS EASY, 8 - EXPRESS EASY, 9 - EUROPACK, A - AUTO REVERSALS, B - BREAKBULK EXPRESS, C - MEDICAL EXPRESS, D - EXPRESS WORLDWIDE, E - EXPRESS 9:00, F - FREIGHT WORLDWIDE, G - DOMESTIC ECONOMY SELECT, H - ECONOMY SELECT, I - DOMESTIC EXPRESS 9:00, J - JUMBO BOX, K - EXPRESS 9:00, L - EXPRESS 10:30, M - EXPRESS 10:30, N - DOMESTIC EXPRESS, O - DOMESTIC EXPRESS 10:30, P - EXPRESS WORLDWIDE, Q - MEDICAL EXPRESS, R - GLOBALMAIL BUSINESS, S - SAME DAY, T - EXPRESS 12:00, U - EXPRESS WORLDWIDE, V - EUROPACK, W - ECONOMY SELECT, X - EXPRESS ENVELOPE, Y - EXPRESS 12:00, Z - Destination Charges]
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
ship_date	string <date-time>
pickup	string <date-time> pickup date time to schedule for the carrier
signature_service	string Value: "SX" signature service option. Signature services are included in international shipments. Use `SX` for no signature required
nonstandard_day	string Enum: "AA" "AB" "AC" "AD" "AG" options are [AA - Saturday Delivery, AB - Saturday Pickup, AC - Holiday Delivery, AD - Holiday Pickup, AG - Domestic Saturday Delivery]
nonstandard_contents	string Enum: "HB" "HC" "HD" "HE" "HG" "HH" "HI" "HK" "HL" "HM" "HN" "HV" "HW" "HY" options are [HB - Lithium Ion PI965 Section II, HC - Dry Ice UN1845, HD - Lithium Ion PI965-966 Section II, HE - Dangerous Goods, HG - Perishable Cargo, HH - Excepted Quantity, HI - Spill Cleaning, HK - Consumer Commodities, HL - Limited Quantities ADR, HM - Lithium Metal PI969 Section II, HN - ADR Load Exemption, HV - Lithium Ion PI967-Section II, HW - Lithium Metal PI970-Section II, HY - Biological UN3373]
is_dutiable	boolean Default: true
federal_tax_id	string <= 20 characters Mandatory for domestic shipment of country code = BR
state_tax_id	string <= 20 characters Mandatory for domestic shipment of country code = BR
duty_payment_type	string Default: "R" Enum: "S" "R" "T" Duties may be paid via Shipper [S], Recipient [R], or Third Party [T]
reference_id	string Identifier for a Return Order
reference_number	string
	object
	object
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
return	boolean Default: false
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
shipping_payment_type	string Default: "S" Enum: "S" "R" "T" Shipping may be paid via Shipper [S], Recipient [R], or Third Party [T]
shipping_payment_account	string Shipment bill to account
duty_payment_account	string Duty bill to account
foreign_trade_regulation	string Enum: "30.2(d)(2)" "30.36" "30.37(a)" "30.37(b)" "30.37(e)" "30.37(f)" "30.37(g)" "30.37(h)" "30.37(i)" "30.37(k)" "30.37(o)" "30.37(q)" "30.37(r)" "30.39" "30.40(a)" "30.40(b)" "30.40(c)" "30.40(d)" Foreign trade regulation code
internal_transaction_number	string 14 characters Internal transaction number provided by the US Customs AES System

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"box_shape": "FLY",
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"declared_value": 0,
"box_shape": "FLY"
}
],
"packing_list_id": 0,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"reason_for_export": "P",
"reason_for_export_explanation": "string",
"declared_value": 0,
"insured_value": 0,
"insurance_type": "dhl",
"shipping_method": "0",
"notify_bill_to": false,
"notify_ship_to": false,
"ship_date": "2019-08-24T14:15:22Z",
"pickup": "2019-08-24T14:15:22Z",
"signature_service": "SX",
"nonstandard_day": "AA",
"nonstandard_contents": "HB",
"is_dutiable": true,
"federal_tax_id": "string",
"state_tax_id": "string",
"duty_payment_type": "S",
"reference_id": "string",
"reference_number": "string",
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return": false,
"warehouse_id": 0,
"shipping_payment_type": "S",
"shipping_payment_account": "string",
"duty_payment_account": "string",
"foreign_trade_regulation": "30.2(d)(2)",
"internal_transaction_number": "stringstringst"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label D H L Ecommerce

Authorizations:

APIKey

Request Body schema: application/json

shipper_id required	integer
	Array of objects <= 1 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
dangerous_goods	string
delivery_confirmation	string Enum: "DELCON" "SIGCON"
service_endorsement	string Enum: "1" "2" "3" "4" 1 - Address Service Requested; 2 - Forwarding Service Requested; 3 - Change Service Requested; 4 - Return Service Requested
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
declared_value	number
insured_value	number
insurance_type	string Value: "dhl_ecommerce"
shipping_method required	string
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
reference_id	string Identifier for a Return Order (RMA)
reference_number	string
ship_date	string <date-time>
	object (tax_info)
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
return	boolean Default: false
return_reason	string reason for return if return is true

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"declared_value": 0,
"description": "string",
"box_shape": "string"
}
],
"packing_list_id": 0,
"dangerous_goods": "string",
"delivery_confirmation": "DELCON",
"service_endorsement": "1",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"declared_value": 0,
"insured_value": 0,
"insurance_type": "dhl_ecommerce",
"shipping_method": "string",
"notify_bill_to": false,
"notify_ship_to": false,
"reference_id": "string",
"reference_number": "string",
"ship_date": "2019-08-24T14:15:22Z",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"return": false,
"return_reason": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label Endicia

Authorizations:

APIKey

Request Body schema: application/json

reference	string package level customer reference value
	Array of objects <= 1 items [ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
packing_list_id	integer id for packing list for profile template associated with this label
contents_type	string to be deprecated in favor of higher use reason_for_export
reason_for_export	string
contents_explanation	string
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "None" Enum: "None" "DeliveryConfirmation" "SignatureConfirmation" "AdultSignature" "AdultSignatureRestrictedDelivery" "RestrictedDelivery"
hold_for_pickup	boolean
insurance_type	string Enum: "discounted_insurance" "endicia"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from address zip code
nondelivery_option	string Default: "Return" Enum: "Return" "Abandon"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
reference_id	string Identifier for a Return Order
reference_number	string Customer supplied internal reference for the order
return	boolean
ship_date	string <date-time>
shipper_id required	integer
shipping_method required	string
stealth	boolean
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"reference": "string",
"packages": [{"box_shape": "SmallFlatRateBox",
"height": 0,
"length": 0,
"reference": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"contents_type": "string",
"reason_for_export": "string",
"contents_explanation": "string",
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "None",
"hold_for_pickup": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "Return",
"notify_bill_to": false,
"notify_ship_to": false,
"reference_id": "string",
"reference_number": "string",
"return": true,
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipping_method": "string",
"stealth": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"warehouse_id": 0
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label Fedex

Authorizations:

APIKey

Request Body schema: application/json

alcohol_shipment_license	string
	object (v1_address)
b13a_filing_option	string Enum: "NOT_REQUIRED" "MANUALLY_ATTACHED" "FILED_ELECTRONICALLY" "SUMMARY_REPORTING" "FEDEX_TO_STAMP" Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands
	object
declared_value	number Package level Insured Value for Fedex
reference_number	string Package level reference, not always necessarily a number
	Array of objects <= 99 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
export_compliance_statement	string For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.
	object
insurance_type	string Enum: "discounted_insurance" "fedex"
insured_value	number Default: 0
label_type	string Enum: "STOCK_4X85_TRAILING_DOC_TAB" "STOCK_4X105_TRAILING_DOC_TAB" FedEx: option for Tire Loss labels with doc tab
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
one_rate	boolean
payment_account	string
payment_type	string
pharmacy_delivery	boolean Default: false
priority_alert	string Enum: "PRIORITY_ALERT" "PRIORITY_ALERT_PLUS"
reason_for_export	string Enum: "SOLD" "NOT_SOLD" "PERSONAL_EFFECTS" "GIFT" "REPAIR_AND_RETURN" "SAMPLE"
reason_for_export_explanation	string
	object (tax_info)
recipient_address_is_residential	boolean
return	boolean
saturday_delivery	boolean Default: false
	object (tax_info)
ship_date	string <date-time>
shipper_id required	integer
shipper_type	string
shipping_method required	string
ancillary_endorsement	string Enum: "ADDRESS_CORRECTION" "CARRIER_LEAVE_IF_NO_RESPONSE" "CHANGE_SERVICE" "FORWARDING_SERVICE" "RETURN_SERVICE" Required for Presorted Standard but not for returns or parcel select. They are not all usable for all ancillary endorsements.
smart_post_hub	string
smart_post_indicia	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
dangerous_goods_option	string
dangerous_goods_regulation_type	string
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
etd_service	boolean
	Array of objects[ items ] for referencing previously uploaded ETD for shipment label
hold_at_location	boolean
hold_at_location_id	string
certificate_of_origin	boolean
terms_of_sale	string <= 3 characters FedEx termsOfSale that will populate the Commercial Invoice (or Pro Forma)
use_metric_units	boolean

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"b13a_filing_option": "NOT_REQUIRED",
"cod": {"collection_type": "ANY",
"amount": 0
},
"declared_value": 0,
"reference_number": "string",
"packages": [{"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"reference": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"export_compliance_statement": "string",
"importer_of_record": {"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"tin": {"tin_type": "BUSINESS_NATIONAL",
"number": "string"
},
"account_number": "string"
},
"insurance_type": "discounted_insurance",
"insured_value": 0,
"label_type": "STOCK_4X85_TRAILING_DOC_TAB",
"notify_bill_to": false,
"notify_ship_to": false,
"one_rate": true,
"payment_account": "string",
"payment_type": "string",
"pharmacy_delivery": false,
"priority_alert": "PRIORITY_ALERT",
"reason_for_export": "SOLD",
"reason_for_export_explanation": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"recipient_address_is_residential": true,
"return": true,
"saturday_delivery": false,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipper_type": "string",
"shipping_method": "string",
"ancillary_endorsement": "ADDRESS_CORRECTION",
"smart_post_hub": "string",
"smart_post_indicia": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"dangerous_goods_option": "string",
"dangerous_goods_regulation_type": "string",
"warehouse_id": 0,
"etd_service": true,
"etd_preshipment_docs": [{"id": "string",
"document_type": "string"
}
],
"hold_at_location": true,
"hold_at_location_id": "string",
"certificate_of_origin": true,
"terms_of_sale": "str",
"use_metric_units": true
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label Pitney

Authorizations:

APIKey

Request Body schema: application/json

	object (v1_address)
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "DelCon" "Sig" "ADSIG" "ADSIGRD" "SigRD"
hazmat_type	string USPS hazmat input type options
hazmat_electronics	boolean USPS hazmat option for electronics
insurance_type	string Value: "discounted_insurance"
insured_value	number
mailing_zip_code	string mailing post office zip code if different than from address zip code
nondelivery_option	string Enum: "return" "abandon" "redirect"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
	Array of objects[ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
parcel_characteristics	string For nonstandard packages
packing_list_id	integer id for packing list for profile template associated with this label
pitney_rate_type	string
rate_cost	number
reason_for_export	string Enum: "GIFT" "COMMERCIAL_SAMPLE" "MERCHANDISE" "DOCUMENTS" "RETURNED_GOODS" "OTHER"
reason_for_export_explanation	string
reference_id	string RMA only: Identifier for a Return Order
reference_number	string
return	boolean
	object (tax_info)
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer
shipping_method required	string (pitney_shipping_methods) Enum: "ALL" "FCM" "PM" "PMC" "EM" "STDPOST" "PRCLSEL" "MEDIA" "LIB" "FCMI" "FCPIS" "EMI" "PMI" "UGA" USPS service types choices. `ALL` returns all available rates based on box type, dimensions, and addresses. other options include [FCM - First-Class Mail, PM - Priority Mail, PMC - Priority Mail Cubic, EM - Express Mail, STDPOST - Standard Post, PRCLSEL - Parcel Select Ground, MEDIA - Media Mail, LIB - Library Mail, FCMI - First-Class Mail International, FCPIS - First-Class Package International, EMI - Priority Mail Express International, PMI - Priority Mail International]
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "DelCon",
"hazmat_type": "string",
"hazmat_electronics": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "return",
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"parcel_characteristics": "string",
"packing_list_id": 0,
"pitney_rate_type": "string",
"rate_cost": 0,
"reason_for_export": "GIFT",
"reason_for_export_explanation": "string",
"reference_id": "string",
"reference_number": "string",
"return": true,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0,
"shipping_method": "ALL",
"warehouse_id": 0
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label Shippo

Authorizations:

APIKey

Request Body schema: application/json

alcohol_shipment_license	string
	object (v1_address)
ancillary_endorsement	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
dangerous_goods_code	string
dangerous_goods_option	string
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
ignore_bad_address	boolean
insurance_type	string Enum: "shippo" "FEDEX" "ONTRAC" "UPS"
insured_value	number Default: 0
required	Array of objects <= 99 items [ items ]
packing_list_id	integer id for packing list for profile template associated with this label
payment_account	string Account number to be billed
payment_country	string Country iso2 code of account number to be billed (required for UPS third party billing only).
payment_type	string Party to be billed. Available options: SENDER, RECIPIENT, THIRD_PARTY, THIRD_PARTY_CONSIGNEE, COLLECT
payment_zip	string ZIP code of account number to be billed (required for UPS if there is a zip on the billing account).
rate_id	string id of the rate created when fetching rates with shippo, returned on rates response
reference_id	string Identifier for a Return Order
reason_for_export	string Enum: "DOCUMENTS" "GIFT" "HUMANITARIAN_DONATION" "MERCHANDISE" "OTHER" "RETURN_MERCHANDISE" "SAMPLE"
reason_for_export_explanation	string
recipient_address_is_residential	boolean
reference_number	string shipment customer reference value
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean Default: false
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipment_id	string id of the shipment created when fetching rates with shippo, returned on rates response
shipper_id required	integer id of the Ordoro shipper to use when creating the label
shipping_method	string

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ancillary_endorsement": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"dangerous_goods_code": "string",
"dangerous_goods_option": "string",
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"ignore_bad_address": true,
"insurance_type": "shippo",
"insured_value": 0,
"packages": [{"box_shape": "string",
"dry_ice_weight": 0,
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"payment_account": "string",
"payment_country": "string",
"payment_type": "string",
"payment_zip": "string",
"rate_id": "string",
"reference_id": "string",
"reason_for_export": "DOCUMENTS",
"reason_for_export_explanation": "string",
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipment_id": "string",
"shipper_id": 0,
"shipping_method": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label U P S

Authorizations:

APIKey

Request Body schema: application/json

additional_handling	boolean
	object (v1_address)
certificate_origin	boolean Default: false
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string ['0' - None, '1' - Confirm, '2' - Signature, '3' - Adult Signature, '4' - USPS for use with Mail Innovations]
direct_delivery	boolean
dry_ice_regulation_set	string indicates dry ice shipment option [CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada, IATA = For Worldwide Air movement]
insurance_type	string
insured_value	number Default: 0
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
box_shape	string ups box options [01 - UPS Letter, 02 - Customer Supplied Package, 03 - Tube, 04 - PAK, 2a - Small Express Box, 2b - Medium Express Box, 2c - Large Express Box, 24 - UPS 25KG Box, 25 - UPS 10KG Box]
declared_value	number Package level declared value for UPS
description	string Package level description, required for return shipments
dry_ice_weight	number Dry ice weight in ounces, required for dry ice shipments
height	number Height in inches
length	number Length in inches
weight	number weight of the package in ounces
width	number Width in inches
	Array of objects <= 200 items [ items ]
package_bill_type	string Enum: "02" "03" "04" "07" required for shoptimeintransit rates: document, non-document, wwef pallet, or domestic pallet. describes the contents of the package.
packing_list_id	integer id for packing list for profile template associated with this label
payment_type	string Default: "BillShipper" payor for the shipment [BillShipper, BillReceiver, BillThirdParty]
payment_account	string account number for payment type
payment_zip	string postal code of the payor, required for payment_type: BillThirdParty
payment_country	string 2 character country code of the payor, required for payment_type: BillThirdParty
duties_payment_type	string Default: "BillShipper" payor for the shipment [BillShipper, BillReceiver, BillThirdParty]
duties_payment_account	string account number for payment type
duties_payment_zip	string postal code of the payor, required for payment_type: BillThirdParty
duties_payment_country	string 2 character country code of the payor, required for payment_type: BillThirdParty
purchase_order_number	string Customs level purchase order number reference
reason_for_export	string
	object (tax_info)
receiver_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
recipient_address_is_residential	boolean
reference_number	string Customer supplied internal reference for the order
return	boolean
saturday_delivery	boolean Default: false
	object (tax_info)
sender_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
shipper_id required	integer
shipper_type	string
shipping_method required	string options: ['01' - Next Day, '02' - Second Day, '03' - Ground, '07' - Worldwide Express, '08' - Worldwide Expedited, '11' - Standard, '12' - Three Day Select, '13' - Next Day Air Saver, '14' - Next Day AM, '54' - Worldwide Express Plus, '59' - Second Day AM, '65' - Saver, '92' - SurePost Less Than 1 lb, '93' - SurePost Greater Than 1lb, '94' - SurePost BPM, '95' - SurePost Media; The following service types are used with UPS Mail Innovations: 'M2' - USPS First Class Mail, 'M3' - USPS Priority Mail, 'M4' - Expedited Mail Innovations, 'M5' - Priority Mail Innovations, 'M6' - Economy Mail Innovations]
shipper_release	boolean
ship_date	string <date-time> Used for label requests in customs forms export date or commercial invoice: invoice date
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
usps_endorsement	string Required for UPS Mail Innovations shipments
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
cost_center	string <= 30 characters The Cost Center code for UPS Mail Innovations shipments

Responses

Request samples

Payload

Content type

application/json

{"additional_handling": true,
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"certificate_origin": false,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"direct_delivery": true,
"dry_ice_regulation_set": "string",
"insurance_type": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"height": 0,
"length": 0,
"weight": 0,
"width": 0,
"packages": [{"additional_handling": true,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_regulation_set": "string",
"dry_ice_weight": 0,
"hazmat_items": [{"additional_description": "string",
"class_division_number": "string",
"commodity_regulated_level_code": "EQ",
"emergency_contact": "string",
"emergency_phone": "string",
"hazard_label_required": "string",
"id_number": "string",
"packaging_instruction_code": "string",
"packaging_group_type": null,
"packaging_type": "string",
"packaging_type_quantity": "string",
"proper_shipping_name": "string",
"quantity": "string",
"regulation_set": "ADR",
"reportable_quantity": "string",
"sub_risk_class": "string",
"technical_name": "string",
"transport_category": "0",
"transportation_mode": "Cargo Aircraft Only",
"tunnel_restriction_code": "(B)",
"uom": "string"
}
],
"height": 0,
"length": 0,
"reference_number": "string",
"weight": 0,
"width": 0
}
],
"package_bill_type": "02",
"packing_list_id": 0,
"payment_type": "BillShipper",
"payment_account": "string",
"payment_zip": "string",
"payment_country": "string",
"duties_payment_type": "BillShipper",
"duties_payment_account": "string",
"duties_payment_zip": "string",
"duties_payment_country": "string",
"purchase_order_number": "string",
"reason_for_export": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_type": "string",
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"sender_type": "string",
"shipper_id": 0,
"shipper_type": "string",
"shipping_method": "string",
"shipper_release": true,
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"usps_endorsement": "string",
"warehouse_id": 0,
"cost_center": "string"
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Post Return Order Label U S P S Ship

Authorizations:

APIKey

Request Body schema: application/json

shipper_id required	integer
shipping_method required	string options: 'ALL', 'BOUND_PRINTED_MATTER', 'FIRST-CLASS_MAIL', 'FIRST-CLASS_PACKAGE_INTERNATIONAL_SERVICE', 'FIRST-CLASS_PACKAGE_SERVICE', 'LIBRARY_MAIL', 'MARKETING_MAIL_PARCELS', 'MEDIA_MAIL', 'PARCEL_SELECT_LIGHTWEIGHT', 'PARCEL_SELECT', 'PRIORITY_MAIL_EXPRESS_INTERNATIONAL', 'PRIORITY_MAIL_EXPRESS', 'PRIORITY_MAIL_INTERNATIONAL', 'PRIORITY_MAIL', 'USPS_CONNECT_LOCAL', 'USPS_CONNECT_MAIL', 'USPS_CONNECT_REGIONAL', 'USPS_GROUND_ADVANTAGE'
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
ship_date	string <date-time>
	object (v1_address)
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "921" "922" "923" "924" "981"
insurance_type	string Value: "discounted_insurance"
insured_value	number Default: 0
has_nonstandard_characteristics	boolean
nondelivery_option	string Enum: "RETURN" "ABANDON" "REDIRECT"
mailing_zip_code	string mailing post office zip code if different than from address zip code
	Array of objects[ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
packing_list_id	integer id for packing list for profile template associated with this label
processing_category required	string Enum: "MACHINABLE" "FLATS" "NONSTANDARD" "LETTERS" returned on rates to be used for label creation
rate_indicator	string from the rate response
reason_for_export	string Enum: "COMMERCIAL_SAMPLE" "CREMATED_REMAINS" "DANGEROUS_GOODS" "DOCUMENT" "GIFT" "HUMANITARIAN_DONATIONS" "MEDICAL_SUPPLIES" "MERCHANDISE" "NON_NEGOTIABLE_DOCUMENT" "OTHER" "PHARMACEUTICALS" "RETURNED_GOODS"
reason_for_export_explanation	string
reference_id	string
reference_number	string
	object (tax_info)
	object (tax_info)
return	boolean
invoice_number	string
hazmat_type	string hazmat input type options
ignore_bad_address	boolean

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"shipping_method": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"notify_bill_to": false,
"notify_ship_to": false,
"ship_date": "2019-08-24T14:15:22Z",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "921",
"insurance_type": "discounted_insurance",
"insured_value": 0,
"has_nonstandard_characteristics": true,
"nondelivery_option": "RETURN",
"mailing_zip_code": "string",
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"packing_list_id": 0,
"processing_category": "MACHINABLE",
"rate_indicator": "string",
"reason_for_export": "COMMERCIAL_SAMPLE",
"reason_for_export_explanation": "string",
"reference_id": "string",
"reference_number": "string",
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"return": true,
"invoice_number": "string",
"hazmat_type": "string",
"ignore_bad_address": true
}

Response samples

Content type

application/json

{"delivery_confirmation": null,
"tracking_number": "string",
"package_tracking": "string",
"tracking_url": "string",
"cost": 0,
"transaction_fee": 0,
"link": "string",
"shipping_method": "string",
"display_shipping_method": "string",
"ship_date": "2019-08-24T14:15:22Z",
"has_label": true,
"has_additional_docs": true,
"created_date": "string",
"carrier_name": "string",
"carrier": {"id": 0,
"link": "string"
},
"estimated_delivery_date": "string",
"box_shape": "string",
"length": 0,
"width": 0,
"height": 0,
"insurance": { },
"insured_value": 0,
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0
}
],
"ship_from": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"reference_number": "string",
"return_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"ship_to": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"status": "string",
"carrier_updated_date": "string",
"presets": [0
],
"packages": [{ }
],
"packing_list_id": 0,
"print_date": "string",
"label_image_link": "string",
"void": true,
"zone": "string"
}

Return Order Rate

Post Return Order Rate Amazon Shipper

Authorizations:

APIKey

Request Body schema: application/json

is_hazmat	boolean Default: false boolean indicator for hazardous materials
	Array of objects <= 1 items [ items ]
recipient_address_is_residential	boolean
reference_number	string
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer

Responses

Request samples

Payload

Content type

application/json

{"is_hazmat": false,
"packages": [{"box_shape": "string",
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"weight": 0,
"width": 0
}
],
"recipient_address_is_residential": true,
"reference_number": "string",
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate Australia Post

Authorizations:

APIKey

Request Body schema: application/json

box_shape	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string
insurance_type	string
insured_value	number
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
required	Array of objects <= 200 items [ items ]
reason_for_export	string
reference_number	string Package level reference, not always necessarily a number
ship_date	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer
reference_id	string Identifier for a Return Order
shipping_method	string ignored for rate requests
property name*	any

Responses

Request samples

Payload

Content type

application/json

{"box_shape": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"insurance_type": "string",
"insured_value": 0,
"notify_bill_to": false,
"notify_ship_to": false,
"packages": [{"additional_handling": true,
"box_shape": "string",
"height": 0,
"length": 0,
"reference_number": "string",
"reference": "string",
"weight": 0,
"width": 0
}
],
"reason_for_export": "string",
"reference_number": "string",
"ship_date": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0,
"reference_id": "string",
"shipping_method": "string"
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate Canada Post

Authorizations:

APIKey

Request Body schema: application/json

reason_for_export	string Enum: "SOG" "DOC" "SAM" "REP" "OTH"
nondelivery_option	string Enum: "RASE" "RTS" "ABAN"
delivery_confirmation	string Enum: "SO" "PA18" "PA19"
service_option	string
insurance_type	string Value: "canada_post"
insured_value	number Default: 0
shipper_id required	integer
	Array of objects <= 1 items [ items ]
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"reason_for_export": "SOG",
"nondelivery_option": "RASE",
"delivery_confirmation": "SO",
"service_option": "string",
"insurance_type": "canada_post",
"insured_value": 0,
"shipper_id": 0,
"packages": [{"box_shape": "Parcel",
"length": 0,
"width": 0,
"height": 0,
"weight": 0
}
],
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"return": true,
"warehouse_id": 0
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate D H L

Authorizations:

APIKey

Request Body schema: application/json

shipper_id required	integer
	Array of objects <= 1 items [ items ]
declared_value	number Shipment Level Declared Value for Dutiable International Shipments
insured_value	number
insurance_type	string Value: "dhl"
ship_date	string <date-time>
reference_number	string
pickup	string <date-time> pickup date time to schedule for the carrier
signature_service	string Value: "SX" signature service option. Signature services are included in international shipments. Use `SX` for no signature required
nonstandard_day	string Enum: "AA" "AB" "AC" "AD" "AG" options are [AA - Saturday Delivery, AB - Saturday Pickup, AC - Holiday Delivery, AD - Holiday Pickup, AG - Domestic Saturday Delivery]
nonstandard_contents	string Enum: "HB" "HC" "HD" "HE" "HG" "HH" "HI" "HK" "HL" "HM" "HN" "HV" "HW" "HY" options are [HB - Lithium Ion PI965 Section II, HC - Dry Ice UN1845, HD - Lithium Ion PI965-966 Section II, HE - Dangerous Goods, HG - Perishable Cargo, HH - Excepted Quantity, HI - Spill Cleaning, HK - Consumer Commodities, HL - Limited Quantities ADR, HM - Lithium Metal PI969 Section II, HN - ADR Load Exemption, HV - Lithium Ion PI967-Section II, HW - Lithium Metal PI970-Section II, HY - Biological UN3373]
is_dutiable	boolean Default: true
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
return	boolean Default: false For orders, determines whether the originating and destination addresses will be swapped for a return label request
warehouse_id	integer DEPRECATED: ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"packages": [{"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"declared_value": 0,
"box_shape": "FLY"
}
],
"declared_value": 0,
"insured_value": 0,
"insurance_type": "dhl",
"ship_date": "2019-08-24T14:15:22Z",
"reference_number": "string",
"pickup": "2019-08-24T14:15:22Z",
"signature_service": "SX",
"nonstandard_day": "AA",
"nonstandard_contents": "HB",
"is_dutiable": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"return": false,
"warehouse_id": 0
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate Endicia

Authorizations:

APIKey

Request Body schema: application/json

	Array of objects <= 1 items [ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
contents_type	string to be deprecated in favor of higher use reason_for_export
reason_for_export	string
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "None" Enum: "None" "DeliveryConfirmation" "SignatureConfirmation" "AdultSignature" "AdultSignatureRestrictedDelivery" "RestrictedDelivery"
hold_for_pickup	boolean
insurance_type	string Enum: "discounted_insurance" "endicia"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from address zip code
nondelivery_option	string Default: "Return" Enum: "Return" "Abandon"
notify_bill_to	boolean Default: false
notify_ship_to	boolean Default: false
reference_number	string Customer supplied internal reference for an order
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
ship_date	string <date-time>
shipper_id required	integer
shipping_method	string
stealth	boolean NOTE: Ignored for rates. Display indicia on the label
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"packages": [{"box_shape": "SmallFlatRateBox",
"height": 0,
"length": 0,
"reference": "string",
"weight": 0,
"width": 0
}
],
"contents_type": "string",
"reason_for_export": "string",
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "None",
"hold_for_pickup": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "Return",
"notify_bill_to": false,
"notify_ship_to": false,
"reference_number": "string",
"return": true,
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"shipping_method": "string",
"stealth": true,
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"warehouse_id": 0
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate Fedex

Authorizations:

APIKey

Request Body schema: application/json

alcohol_shipment_license	string
b13a_filing_option	string Enum: "NOT_REQUIRED" "MANUALLY_ATTACHED" "FILED_ELECTRONICALLY" "SUMMARY_REPORTING" "FEDEX_TO_STAMP" Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands
declared_value	number Package level Insured Value for Fedex
	Array of objects[ items ] for referencing previously uploaded ETD for shipment label
	Array of objects <= 99 items [ items ]
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
export_compliance_statement	string For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.
	object
insurance_type	string Enum: "discounted_insurance" "fedex"
insured_value	number Default: 0
one_rate	boolean
payment_account	string
payment_type	string
pharmacy_delivery	boolean Default: false
priority_alert	string Enum: "PRIORITY_ALERT" "PRIORITY_ALERT_PLUS"
reason_for_export	string Enum: "SOLD" "NOT_SOLD" "PERSONAL_EFFECTS" "GIFT" "REPAIR_AND_RETURN" "SAMPLE"
reason_for_export_explanation	string
	object (tax_info)
recipient_address_is_residential	boolean
reference_number	string
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean Default: false
	object (tax_info)
ship_date	string <date-time>
shipper_id required	integer
ancillary_endorsement	string Enum: "ADDRESS_CORRECTION" "CARRIER_LEAVE_IF_NO_RESPONSE" "CHANGE_SERVICE" "FORWARDING_SERVICE" "RETURN_SERVICE" Required for Presorted Standard but not for returns or parcel select. They are not all usable for all ancillary endorsements.
smart_post_hub	string
smart_post_indicia	string
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
dangerous_goods_option	string
dangerous_goods_regulation_type	string
etd_service	boolean
hold_at_location	boolean
hold_at_location_id	string
certificate_of_origin	boolean
use_metric_units	boolean

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"b13a_filing_option": "NOT_REQUIRED",
"declared_value": 0,
"etd_preshipment_docs": [{"id": "string",
"document_type": "string"
}
],
"packages": [{"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"reference": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"export_compliance_statement": "string",
"importer_of_record": {"address": {"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"reference_number": "string",
"revision_locked_fields": [ ],
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"tin": {"tin_type": "BUSINESS_NATIONAL",
"number": "string"
},
"account_number": "string"
},
"insurance_type": "discounted_insurance",
"insured_value": 0,
"one_rate": true,
"payment_account": "string",
"payment_type": "string",
"pharmacy_delivery": false,
"priority_alert": "PRIORITY_ALERT",
"reason_for_export": "SOLD",
"reason_for_export_explanation": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"shipper_id": 0,
"ancillary_endorsement": "ADDRESS_CORRECTION",
"smart_post_hub": "string",
"smart_post_indicia": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"dangerous_goods_option": "string",
"dangerous_goods_regulation_type": "string",
"etd_service": true,
"hold_at_location": true,
"hold_at_location_id": "string",
"certificate_of_origin": true,
"use_metric_units": true
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate Pitney

Authorizations:

APIKey

Request Body schema: application/json

customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "DelCon" "Sig" "ADSIG" "ADSIGRD" "SigRD"
hazmat_type	string USPS hazmat input type options
hazmat_electronics	boolean USPS hazmat option for electronics
insurance_type	string Value: "discounted_insurance"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from_address zip code, ignored in rate request
nondelivery_option	string Enum: "return" "abandon" "redirect"
	Array of objects <= 1 items [ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
parcel_characteristics	string For nonstandard packages
pitney_rate_type	string
reason_for_export	string Enum: "GIFT" "COMMERCIAL_SAMPLE" "MERCHANDISE" "DOCUMENTS" "RETURNED_GOODS" "OTHER"
reason_for_export_explanation	string
reference_number	string
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
	object (tax_info)
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
shipper_id required	integer
shipping_method required	string
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.

Responses

Request samples

Payload

Content type

application/json

{"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "DelCon",
"hazmat_type": "string",
"hazmat_electronics": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"nondelivery_option": "return",
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"parcel_characteristics": "string",
"pitney_rate_type": "string",
"reason_for_export": "GIFT",
"reason_for_export_explanation": "string",
"reference_number": "string",
"return": true,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"shipper_id": 0,
"shipping_method": "string",
"warehouse_id": 0
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate Shippo

Authorizations:

APIKey

Request Body schema: application/json

alcohol_shipment_license	string
	object (v1_address)
ancillary_endorsement	string
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
dangerous_goods_code	string
dangerous_goods_option	string
delivery_confirmation	string Default: "SERVICE_DEFAULT" Enum: "NO_SIGNATURE_REQUIRED" "INDIRECT" "DIRECT" "ADULT" "SERVICE_DEFAULT"
delivery_instructions	string
dry_ice_weight	number Default: 0 Weight in ounces.
duties_payment_type	string
duties_payment_account	string
ignore_bad_address	boolean
insurance_type	string Enum: "shippo" "FEDEX" "ONTRAC" "UPS"
insured_value	number Default: 0
required	Array of objects <= 99 items [ items ]
payment_account	string Account number to be billed
payment_country	string Country iso2 code of account number to be billed (required for UPS third party billing only).
payment_type	string Party to be billed. Available options: SENDER, RECIPIENT, THIRD_PARTY, THIRD_PARTY_CONSIGNEE, COLLECT
payment_zip	string ZIP code of account number to be billed (required for UPS if there is a zip on the billing account).
reference_id	string Identifier for a Return Order
reason_for_export	string Enum: "DOCUMENTS" "GIFT" "HUMANITARIAN_DONATION" "MERCHANDISE" "OTHER" "RETURN_MERCHANDISE" "SAMPLE"
reason_for_export_explanation	string
recipient_address_is_residential	boolean
reference_number	string shipment customer reference value
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean Default: false
ship_date	string <date-time>
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
shipper_id required	integer
shipping_method	string

Responses

Request samples

Payload

Content type

application/json

{"alcohol_shipment_license": "string",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ancillary_endorsement": "string",
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"dangerous_goods_code": "string",
"dangerous_goods_option": "string",
"delivery_confirmation": "NO_SIGNATURE_REQUIRED",
"delivery_instructions": "string",
"dry_ice_weight": 0,
"duties_payment_type": "string",
"duties_payment_account": "string",
"ignore_bad_address": true,
"insurance_type": "shippo",
"insured_value": 0,
"packages": [{"box_shape": "string",
"dry_ice_weight": 0,
"declared_value": 0,
"height": 0,
"length": 0,
"reference_number": "string",
"department": "string",
"invoice": "string",
"purchase_order": "string",
"sub_package_type": "string",
"weight": 0,
"width": 0
}
],
"payment_account": "string",
"payment_country": "string",
"payment_type": "string",
"payment_zip": "string",
"reference_id": "string",
"reason_for_export": "DOCUMENTS",
"reason_for_export_explanation": "string",
"recipient_address_is_residential": true,
"reference_number": "string",
"return": true,
"saturday_delivery": false,
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0,
"shipping_method": "string"
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate U P S

Authorizations:

APIKey

Request Body schema: application/json

additional_handling	boolean
	object (v1_address)
certificate_origin	boolean
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string ['0' - None, '1' - Confirm, '2' - Signature, '3' - Adult Signature]
direct_delivery	boolean
dry_ice_regulation_set	string indicates dry ice shipment option [CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada, IATA = For Worldwide Air movement]
insurance_type	string
insured_value	number
box_shape	string DEPRECATED: USE PACKAGES. ups box options [01 - UPS Letter, 02 - Customer Supplied Package, 03 - Tube, 04 - PAK, 2a - Small Express Box, 2b - Medium Express Box, 2c - Large Express Box, 24 - UPS 25KG Box, 25 - UPS 10KG Box]
declared_value	number DEPRECATED: USE PACKAGES. Package level declared value for UPS
description	string DEPRECATED: USE PACKAGES. Package level description, required for return label creation
dry_ice_weight	number DEPRECATED: USE PACKAGES. Dry ice weight in ounces, required for dry ice shipments
purchase_order_number	string Customs level purchase order number reference
reference_number	string Package level reference, not always necessarily a number
weight	number DEPRECATED: USE PACKAGES. Weight in ounces
length	number DEPRECATED: USE PACKAGES. Length in inches
width	number DEPRECATED: USE PACKAGES. Width in inches
height	number DEPRECATED: USE PACKAGES. Height in inches
	Array of objects <= 200 items [ items ]
package_bill_type	string Enum: "02" "03" "04" "07" required for shoptimeintransit rates: document, non-document, wwef pallet, or domestic pallet. describes the contents of the package.
payment_type	string
payment_account	string
payment_zip	string
payment_country	string
duties_payment_type	string
duties_payment_account	string
duties_payment_zip	string
duties_payment_country	string
reason_for_export	string
	object (tax_info)
receiver_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
recipient_address_is_residential	boolean
return	boolean For orders, determines whether the originating and destination addresses will be swapped for a return label request
saturday_delivery	boolean
	object (tax_info)
sender_type	string included with EU inbound shipments and m_pid, ns_pid, s_pid set on customs lines
shipper_id required	integer
shipping_method	string
shipper_release	boolean
usps_endorsement	string Required for UPS Mail Innovations shipments
ship_date	string <date-time> Used for label requests in customs forms export date or commercial invoice: invoice date
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
reference_id	string Identifier for a Return Order
warehouse_id	integer Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
cost_center	string The Cost Center code for UPS Mail Innovations shipments

Responses

Request samples

Payload

Content type

application/json

{"additional_handling": true,
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"certificate_origin": true,
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "string",
"direct_delivery": true,
"dry_ice_regulation_set": "string",
"insurance_type": "string",
"insured_value": 0,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_weight": 0,
"purchase_order_number": "string",
"reference_number": "string",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"packages": [{"additional_handling": true,
"box_shape": "string",
"declared_value": 0,
"description": "string",
"dry_ice_regulation_set": "string",
"dry_ice_weight": 0,
"hazmat_items": [{"additional_description": "string",
"class_division_number": "string",
"commodity_regulated_level_code": "EQ",
"emergency_contact": "string",
"emergency_phone": "string",
"hazard_label_required": "string",
"id_number": "string",
"packaging_instruction_code": "string",
"packaging_group_type": null,
"packaging_type": "string",
"packaging_type_quantity": "string",
"proper_shipping_name": "string",
"quantity": "string",
"regulation_set": "ADR",
"reportable_quantity": "string",
"sub_risk_class": "string",
"technical_name": "string",
"transport_category": "0",
"transportation_mode": "Cargo Aircraft Only",
"tunnel_restriction_code": "(B)",
"uom": "string"
}
],
"height": 0,
"length": 0,
"reference_number": "string",
"weight": 0,
"width": 0
}
],
"package_bill_type": "02",
"payment_type": "string",
"payment_account": "string",
"payment_zip": "string",
"payment_country": "string",
"duties_payment_type": "string",
"duties_payment_account": "string",
"duties_payment_zip": "string",
"duties_payment_country": "string",
"reason_for_export": "string",
"receiver_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"receiver_type": "string",
"recipient_address_is_residential": true,
"return": true,
"saturday_delivery": true,
"sender_tax_info": {"tax_id_number": "string",
"tax_id_type": "string",
"tax_issuer_country": "string"
},
"sender_type": "string",
"shipper_id": 0,
"shipping_method": "string",
"shipper_release": true,
"usps_endorsement": "string",
"ship_date": "2019-08-24T14:15:22Z",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"reference_id": "string",
"warehouse_id": 0,
"cost_center": "string"
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate U S P S Ship

Authorizations:

APIKey

Request Body schema: application/json

shipper_id required	integer
shipping_method	string options: 'ALL', 'BOUND_PRINTED_MATTER', 'FIRST-CLASS_MAIL', 'FIRST-CLASS_PACKAGE_INTERNATIONAL_SERVICE', 'FIRST-CLASS_PACKAGE_SERVICE', 'LIBRARY_MAIL', 'MARKETING_MAIL_PARCELS', 'MEDIA_MAIL', 'PARCEL_SELECT_LIGHTWEIGHT', 'PARCEL_SELECT', 'PRIORITY_MAIL_EXPRESS_INTERNATIONAL', 'PRIORITY_MAIL_EXPRESS', 'PRIORITY_MAIL_INTERNATIONAL', 'PRIORITY_MAIL', 'USPS_CONNECT_LOCAL', 'USPS_CONNECT_MAIL', 'USPS_CONNECT_REGIONAL', 'USPS_GROUND_ADVANTAGE'
	object (v1_address) The ship_from address is used as the originating address of the rate and label request.
	object (v1_address) The to address is used as the destination address of a return order rate and label request.
ship_date	string <date-time>
	object (v1_address)
customs	object internal use only
	Array of objects (Customs Line Schema) [ items ]
delivery_confirmation	string Enum: "921" "922" "923" "924" "981"
has_nonstandard_characteristics	boolean
insurance_type	string Value: "discounted_insurance"
insured_value	number Default: 0
mailing_zip_code	string mailing post office zip code if different than from address zip code
	Array of objects[ items ] This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
processing_category	string Enum: "MACHINABLE" "FLATS" "NONSTANDARD" "LETTERS" optional for filtering rates
reason_for_export	string Enum: "COMMERCIAL_SAMPLE" "CREMATED_REMAINS" "DANGEROUS_GOODS" "DOCUMENTS" "GIFT" "HUMANITARIAN_DONATIONS" "MEDICAL_SUPPLIES" "MERCHANDISE" "NON_NEGOTIABLE_DOCUMENT" "OTHER" "PHARMACEUTICALS" "RETURNED_GOODS"
reason_for_export_explanation	string
reference_number	string
return	boolean
hazmat_type	string hazmat input type options

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"shipping_method": "string",
"ship_from": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"ship_date": "2019-08-24T14:15:22Z",
"alternate_return_to_address": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"customs": { },
"customs_info": [{"country": "string",
"description": "string",
"quantity": 0,
"value": 0,
"weight": 0,
"harmonization_code": "string",
"sku": "string",
"unit_of_measure": "string",
"url": "string",
"harmonization_code_country": "string",
"m_pid": "string",
"ns_pid": "string",
"s_pid": "string"
}
],
"delivery_confirmation": "921",
"has_nonstandard_characteristics": true,
"insurance_type": "discounted_insurance",
"insured_value": 0,
"mailing_zip_code": "string",
"packages": [{"box_shape": "string",
"height": 0,
"length": 0,
"weight": 0,
"width": 0
}
],
"processing_category": "MACHINABLE",
"reason_for_export": "COMMERCIAL_SAMPLE",
"reason_for_export_explanation": "string",
"reference_number": "string",
"return": true,
"hazmat_type": "string"
}

Response samples

Content type

application/json

[{"service_type": "string",
"rate": 0,
"transaction_fee": 0,
"box_type": "string",
"carrier": "string",
"carrier_account_id": "string",
"estimated_delivery_days": "string",
"estimated_delivery_date": "string",
"display": "string",
"one_rate": true,
"processing_category": "string",
"rate_id": "string",
"rate_indicator": "string",
"saturday_delivery": true,
"shipment_id": "string",
"service_token": "string",
"zone": "string"
}
]

Post Return Order Rate

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Rule

Delete Rule

Authorizations:

APIKey

Responses

Get Rule

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
latch	string
active	string

Responses

Post Rule

Authorizations:

APIKey

Request Body schema: application/json

latch	string
condition	string
action	Array of strings
active	string
index	integer
internal_notes	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"latch": "string",
"condition": "string",
"action": ["string"
],
"active": "string",
"index": 0,
"internal_notes": "string"
}

Put Rule

Authorizations:

APIKey

Request Body schema: application/json

latch	string
condition	string
action	Array of strings
active	string
index	integer
archive_date	string <date-time>
internal_notes	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"latch": "string",
"condition": "string",
"action": ["string"
],
"active": "string",
"index": 0,
"archive_date": "2019-08-24T14:15:22Z",
"internal_notes": "string"
}

Put Rules Reorder

Authorizations:

APIKey

Request Body schema: application/json

new_indices

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"new_indices": ["string"
]
}

Delete Rule

Authorizations:

APIKey

path Parameters

rule_id

required

integer

Responses

Get Rule

Authorizations:

APIKey

path Parameters

rule_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
latch	string
active	string

Responses

Post Rule

Authorizations:

APIKey

path Parameters

rule_id

required

integer

Request Body schema: application/json

latch	string
condition	string
action	Array of strings
active	string
index	integer
internal_notes	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"latch": "string",
"condition": "string",
"action": ["string"
],
"active": "string",
"index": 0,
"internal_notes": "string"
}

Put Rule

Authorizations:

APIKey

path Parameters

rule_id

required

integer

Request Body schema: application/json

latch	string
condition	string
action	Array of strings
active	string
index	integer
archive_date	string <date-time>
internal_notes	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"latch": "string",
"condition": "string",
"action": ["string"
],
"active": "string",
"index": 0,
"archive_date": "2019-08-24T14:15:22Z",
"internal_notes": "string"
}

Shipper

Delete Shipper

Authorizations:

APIKey

Responses

Get Shipper

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
all	string

Responses

Post Shipper

Authorizations:

APIKey

Request Body schema: application/json

vendor

string

Responses

Request samples

Payload

Content type

application/json

{"vendor": "string"
}

Put Shipper

Authorizations:

APIKey

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Delete Shipper

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

Responses

Get Shipper

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
all	string

Responses

Post Shipper

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

Request Body schema: application/json

vendor

string

Responses

Request samples

Payload

Content type

application/json

{"vendor": "string"
}

Put Shipper

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Get Shipper End Of Day Forms

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

Responses

Post Shipper Image

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

Request Body schema: application/json

data required	string Currently used for FedEx only: GIF, PNG, JPG, or PDF image base64 encoded string
image_type required	string Enum: "letterhead_image" "signature_image"

Responses

Request samples

Payload

Content type

application/json

{"data": "string",
"image_type": "letterhead_image"
}

Post Shipper Refresh Creds

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

Request Body schema: application/json

force

boolean

Responses

Request samples

Payload

Content type

application/json

{"force": true
}

Stocktake

Get Stocktake

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
search	string
tag	Array of strings
untagged	boolean
tag_filter_by	string Enum: "or" "and" "only" "not"
exclude_tags	Array of strings
reference_id	Array of strings
warehouse_id	Array of integers[ items ]
started	boolean
completed	boolean
cancelled	boolean
sort	Array of strings Items Enum: "reference_id" "-reference_id" "warehouse_name" "-warehouse_name" "created_date" "-created_date" "updated_date" "-updated_date" "started_date" "-started_date" "completed_date" "-completed_date" "cancelled_date" "-cancelled_date"

Responses

Response samples

Content type

application/json

{"limit": 0,
"offset": 0,
"count": 0,
"stocktake": [{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}
]
}

Head Stocktake

Authorizations:

APIKey

Responses

Post Stocktake

Authorizations:

APIKey

Request Body schema: application/json

reference_id required	string
warehouse_id	integer
internal_notes	string or null
criteria	object

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"warehouse_id": 0,
"internal_notes": "string",
"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Put Stocktake

Authorizations:

APIKey

Request Body schema: application/json

reference_id	string
internal_notes	string or null
started_date	string or null
completed_date	string or null
cancelled_date	string or null

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Delete Stocktake Tag

Authorizations:

APIKey

Responses

Get Stocktake Tag

Authorizations:

APIKey

query Parameters

limit	integer [ 1 .. 100 ] Default: 10
offset	integer Default: 0
id	Array of integers[ items ]

Responses

Response samples

Content type

application/json

{"count": 0,
"tag": [{"id": 0,
"name": "string",
"color": "string"
}
],
"limit": 10,
"offset": 0
}

Post Stocktake Tag

Authorizations:

APIKey

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Stocktake Tag

Authorizations:

APIKey

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Delete Stocktake Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Get Stocktake Tag

Authorizations:

APIKey

path Parameters

name

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Post Stocktake Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Put Stocktake Tag

Authorizations:

APIKey

path Parameters

name

required

string

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"color": "string"
}

Get Stocktake

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Head Stocktake

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Post Stocktake

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

reference_id required	string
warehouse_id	integer
internal_notes	string or null
criteria	object

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"warehouse_id": 0,
"internal_notes": "string",
"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Put Stocktake

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

reference_id	string
internal_notes	string or null
started_date	string or null
completed_date	string or null
cancelled_date	string or null

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"internal_notes": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Get Stocktake Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Response samples

Content type

application/json

{"count": 35,
"limit": 1,
"offset": 0,
"comment": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
]
}

Post Stocktake Comment

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}

Delete Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

criteria

object

Responses

Request samples

Payload

Content type

application/json

{"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Get Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
fba	string
fbm	string
category	Array of strings
hs_code	Array of strings
m_pid	Array of strings
ns_pid	Array of strings
s_pid	Array of strings
active	string
kit	string
kit_component	string
manufactured	string
manufacturing_component	string
dropship	string
needs_sync	string
inventory_sync_suspended	string
supplier	Array of integers[ items ]
no_supplier	string
sales_channel	Array of integers[ items ]
low_inventory_aoh	string
low_inventory_poh	string
to_be_shipped	string
oversold	string
reordered	string
overallocated	string
tag	Array of strings
untagged	string
exclude_tags	Array of strings
tag_filter_by	string
warehouse_id	Array of integers[ items ]
sku	Array of strings
product_type	string
fulfillment_type	Array of strings
updated_after	string <date-time>
updated_before	string <date-time>
barcode	Array of strings
stocktake_reference_id	string
cart	integer
started	string
counted	string
reconciled	string

Responses

Post Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

internal_notes	string
criteria	object

Responses

Request samples

Payload

Content type

application/json

{"internal_notes": "string",
"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Put Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

internal_notes

string

Responses

Request samples

Payload

Content type

application/json

{"internal_notes": "string"
}

Delete Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id required	string
stocktake_line_id required	integer

Request Body schema: application/json

criteria

object

Responses

Request samples

Payload

Content type

application/json

{"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Get Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id required	string
stocktake_line_id required	integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
fba	string
fbm	string
category	Array of strings
hs_code	Array of strings
m_pid	Array of strings
ns_pid	Array of strings
s_pid	Array of strings
active	string
kit	string
kit_component	string
manufactured	string
manufacturing_component	string
dropship	string
needs_sync	string
inventory_sync_suspended	string
supplier	Array of integers[ items ]
no_supplier	string
sales_channel	Array of integers[ items ]
low_inventory_aoh	string
low_inventory_poh	string
to_be_shipped	string
oversold	string
reordered	string
overallocated	string
tag	Array of strings
untagged	string
exclude_tags	Array of strings
tag_filter_by	string
warehouse_id	Array of integers[ items ]
sku	Array of strings
product_type	string
fulfillment_type	Array of strings
updated_after	string <date-time>
updated_before	string <date-time>
barcode	Array of strings
stocktake_reference_id	string
cart	integer
started	string
counted	string
reconciled	string

Responses

Post Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id required	string
stocktake_line_id required	integer

Request Body schema: application/json

internal_notes	string
criteria	object

Responses

Request samples

Payload

Content type

application/json

{"internal_notes": "string",
"criteria": { }
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Put Stocktake Line

Authorizations:

APIKey

path Parameters

reference_id required	string
stocktake_line_id required	integer

Request Body schema: application/json

internal_notes

string

Responses

Request samples

Payload

Content type

application/json

{"internal_notes": "string"
}

Post Stocktake Line Count

Authorizations:

APIKey

path Parameters

reference_id required	string
stocktake_line_id required	integer

Request Body schema: application/json

comment	string
counted_quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"comment": "string",
"counted_quantity": 0
}

Post Stocktake Line Reconcile

Authorizations:

APIKey

path Parameters

reference_id required	string
stocktake_line_id required	integer

Request Body schema: application/json

comment	string
criteria	object

Responses

Request samples

Payload

Content type

application/json

{"comment": "string",
"criteria": { }
}

Post Stocktake Line Start

Authorizations:

APIKey

path Parameters

reference_id required	string
stocktake_line_id required	integer

Request Body schema: application/json

criteria

object

Responses

Request samples

Payload

Content type

application/json

{"criteria": { }
}

Post Stocktake Line Reconcile

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

comment	string
criteria	object

Responses

Request samples

Payload

Content type

application/json

{"comment": "string",
"criteria": { }
}

Post Stocktake Line Start

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

criteria

object

Responses

Request samples

Payload

Content type

application/json

{"criteria": { }
}

Delete Stocktake Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

reference_id required	string
name required	string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Post Stocktake Apply Or Remove Tag

Authorizations:

APIKey

path Parameters

reference_id required	string
name required	string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"started_date": "string",
"completed_date": "string",
"cancelled_date": "string",
"internal_notes": "string",
"warehouse_id": 0,
"line_count": { },
"comments": [{"user": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"color": "string"
}
]
}

Supplier

Get Supplier

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0

Responses

Post Supplier

Authorizations:

APIKey

Request Body schema: application/json

automatically_show_images_email	boolean Default: false
automatically_show_images_packing_list	boolean Default: false
automatically_show_ship_to_email	boolean Default: false
automatically_show_supplier_price	boolean Default: false
dropship_prefer_cart_order_line_names	boolean Default: true
automatically_show_customer_notes_email	boolean Default: true
default_shipping_method	string or null
default_shipping_account	string or null
default_shipping_carrier	string or null
dropshipment_sender_contact_id	integer or null
dropshipment_routing_contact_id	integer or null
dropshipment_routing_address	string or null
dropshipment_routing_channel	string Default: "email" Enum: "no_communication" "email"
po_sender_contact_id	integer or null
po_routing_contact_id	integer or null
po_routing_address	string or null
po_routing_channel	string Default: "email" Enum: "no_communication" "email"
warehouse_id	integer or null
id	integer
name	string or null
company required	string or null
street1	string or null
street2	string or null
city	string or null
state	string or null
zip	string or null
country	string or null
email	string or null
email_cc	string or null
email_bcc	string or null
phone	string or null
fax	string or null
cart_address_id	string or null
revision_locked_fields	array

Responses

Request samples

Payload

Content type

application/json

{"automatically_show_images_email": false,
"automatically_show_images_packing_list": false,
"automatically_show_ship_to_email": false,
"automatically_show_supplier_price": false,
"dropship_prefer_cart_order_line_names": true,
"automatically_show_customer_notes_email": true,
"default_shipping_method": "string",
"default_shipping_account": "string",
"default_shipping_carrier": "string",
"dropshipment_sender_contact_id": 0,
"dropshipment_routing_contact_id": 0,
"dropshipment_routing_address": "string",
"dropshipment_routing_channel": "no_communication",
"po_sender_contact_id": 0,
"po_routing_contact_id": 0,
"po_routing_address": "string",
"po_routing_channel": "no_communication",
"warehouse_id": 0,
"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"revision_locked_fields": [ ]
}

Put Supplier

Authorizations:

APIKey

Request Body schema: application/json

automatically_show_images_email	boolean Default: false
automatically_show_images_packing_list	boolean Default: false
automatically_show_ship_to_email	boolean Default: false
automatically_show_supplier_price	boolean Default: false
dropship_prefer_cart_order_line_names	boolean Default: true
automatically_show_customer_notes_email	boolean Default: true
default_shipping_method	string or null
default_shipping_account	string or null
default_shipping_carrier	string or null
dropshipment_sender_contact_id	integer or null
dropshipment_routing_contact_id	integer or null
dropshipment_routing_address	string or null
dropshipment_routing_channel	string Default: "email" Enum: "no_communication" "email"
po_sender_contact_id	integer or null
po_routing_contact_id	integer or null
po_routing_address	string or null
po_routing_channel	string Default: "email" Enum: "no_communication" "email"
warehouse_id	integer or null
id	integer
name	string or null
company	string or null
street1	string or null
street2	string or null
city	string or null
state	string or null
zip	string or null
country	string or null
email	string or null
email_cc	string or null
email_bcc	string or null
phone	string or null
fax	string or null
cart_address_id	string or null
revision_locked_fields	array

Responses

Request samples

Payload

Content type

application/json

{"automatically_show_images_email": false,
"automatically_show_images_packing_list": false,
"automatically_show_ship_to_email": false,
"automatically_show_supplier_price": false,
"dropship_prefer_cart_order_line_names": true,
"automatically_show_customer_notes_email": true,
"default_shipping_method": "string",
"default_shipping_account": "string",
"default_shipping_carrier": "string",
"dropshipment_sender_contact_id": 0,
"dropshipment_routing_contact_id": 0,
"dropshipment_routing_address": "string",
"dropshipment_routing_channel": "no_communication",
"po_sender_contact_id": 0,
"po_routing_contact_id": 0,
"po_routing_address": "string",
"po_routing_channel": "no_communication",
"warehouse_id": 0,
"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"revision_locked_fields": [ ]
}

Get Supplier Null

Authorizations:

APIKey

Responses

Get Supplier

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Responses

Post Supplier

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Request Body schema: application/json

automatically_show_images_email	boolean Default: false
automatically_show_images_packing_list	boolean Default: false
automatically_show_ship_to_email	boolean Default: false
automatically_show_supplier_price	boolean Default: false
dropship_prefer_cart_order_line_names	boolean Default: true
automatically_show_customer_notes_email	boolean Default: true
default_shipping_method	string or null
default_shipping_account	string or null
default_shipping_carrier	string or null
dropshipment_sender_contact_id	integer or null
dropshipment_routing_contact_id	integer or null
dropshipment_routing_address	string or null
dropshipment_routing_channel	string Default: "email" Enum: "no_communication" "email"
po_sender_contact_id	integer or null
po_routing_contact_id	integer or null
po_routing_address	string or null
po_routing_channel	string Default: "email" Enum: "no_communication" "email"
warehouse_id	integer or null
id	integer
name	string or null
company required	string or null
street1	string or null
street2	string or null
city	string or null
state	string or null
zip	string or null
country	string or null
email	string or null
email_cc	string or null
email_bcc	string or null
phone	string or null
fax	string or null
cart_address_id	string or null
revision_locked_fields	array

Responses

Request samples

Payload

Content type

application/json

{"automatically_show_images_email": false,
"automatically_show_images_packing_list": false,
"automatically_show_ship_to_email": false,
"automatically_show_supplier_price": false,
"dropship_prefer_cart_order_line_names": true,
"automatically_show_customer_notes_email": true,
"default_shipping_method": "string",
"default_shipping_account": "string",
"default_shipping_carrier": "string",
"dropshipment_sender_contact_id": 0,
"dropshipment_routing_contact_id": 0,
"dropshipment_routing_address": "string",
"dropshipment_routing_channel": "no_communication",
"po_sender_contact_id": 0,
"po_routing_contact_id": 0,
"po_routing_address": "string",
"po_routing_channel": "no_communication",
"warehouse_id": 0,
"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"revision_locked_fields": [ ]
}

Put Supplier

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Request Body schema: application/json

automatically_show_images_email	boolean Default: false
automatically_show_images_packing_list	boolean Default: false
automatically_show_ship_to_email	boolean Default: false
automatically_show_supplier_price	boolean Default: false
dropship_prefer_cart_order_line_names	boolean Default: true
automatically_show_customer_notes_email	boolean Default: true
default_shipping_method	string or null
default_shipping_account	string or null
default_shipping_carrier	string or null
dropshipment_sender_contact_id	integer or null
dropshipment_routing_contact_id	integer or null
dropshipment_routing_address	string or null
dropshipment_routing_channel	string Default: "email" Enum: "no_communication" "email"
po_sender_contact_id	integer or null
po_routing_contact_id	integer or null
po_routing_address	string or null
po_routing_channel	string Default: "email" Enum: "no_communication" "email"
warehouse_id	integer or null
id	integer
name	string or null
company	string or null
street1	string or null
street2	string or null
city	string or null
state	string or null
zip	string or null
country	string or null
email	string or null
email_cc	string or null
email_bcc	string or null
phone	string or null
fax	string or null
cart_address_id	string or null
revision_locked_fields	array

Responses

Request samples

Payload

Content type

application/json

{"automatically_show_images_email": false,
"automatically_show_images_packing_list": false,
"automatically_show_ship_to_email": false,
"automatically_show_supplier_price": false,
"dropship_prefer_cart_order_line_names": true,
"automatically_show_customer_notes_email": true,
"default_shipping_method": "string",
"default_shipping_account": "string",
"default_shipping_carrier": "string",
"dropshipment_sender_contact_id": 0,
"dropshipment_routing_contact_id": 0,
"dropshipment_routing_address": "string",
"dropshipment_routing_channel": "no_communication",
"po_sender_contact_id": 0,
"po_routing_contact_id": 0,
"po_routing_address": "string",
"po_routing_channel": "no_communication",
"warehouse_id": 0,
"id": 0,
"name": "Jimmy McGill",
"company": "Hamlin, Hamlin & McGill",
"street1": "100 Constitution Ave",
"street2": "string",
"city": "Albuquerque",
"state": "NM",
"zip": "87109",
"country": "US",
"email": "slippin-jimmy@saul-good.man",
"email_cc": "slippin-jimmy@saul-good.man",
"email_bcc": "slippin-jimmy@saul-good.man",
"phone": "555-867-5309",
"fax": "string",
"cart_address_id": "string",
"revision_locked_fields": [ ]
}

Post Supplier Archive

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Responses

Delete Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Responses

Response samples

Content type

application/json

{"active": true,
"created": "string",
"id": 0,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string",
"supplier_id": 0,
"updated": "string"
}

Get Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Responses

Post Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Request Body schema: application/json

active	boolean
requested_shipping_method required	string or null Default: "" The requested shipping method on an Order to be mapped to a determinate shipping method
mapped_shipping_method required	string For FBA, must be one of the following: ['Expedited', 'Priority', 'Standard']
mapped_shipping_account	string or null
mapped_shipping_carrier	string or null

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string"
}

Response samples

Content type

application/json

{"active": true,
"created": "string",
"id": 0,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string",
"supplier_id": 0,
"updated": "string"
}

Put Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id

required

integer

Request Body schema: application/json

active	boolean
requested_shipping_method	string The requested shipping method on an Order to be mapped to a determinate shipping method
mapped_shipping_method	string For FBA, must be one of the following: ['Expedited', 'Priority', 'Standard']
mapped_shipping_account	string or null
mapped_shipping_carrier	string or null

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"requested_shipping_method": "string",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string"
}

Response samples

Content type

application/json

{"active": true,
"created": "string",
"id": 0,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string",
"supplier_id": 0,
"updated": "string"
}

Delete Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id required	integer
shipping_method_map_id required	integer

Responses

Response samples

Content type

application/json

{"active": true,
"created": "string",
"id": 0,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string",
"supplier_id": 0,
"updated": "string"
}

Get Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id required	integer
shipping_method_map_id required	integer

Responses

Post Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id required	integer
shipping_method_map_id required	integer

Request Body schema: application/json

active	boolean
requested_shipping_method required	string or null Default: "" The requested shipping method on an Order to be mapped to a determinate shipping method
mapped_shipping_method required	string For FBA, must be one of the following: ['Expedited', 'Priority', 'Standard']
mapped_shipping_account	string or null
mapped_shipping_carrier	string or null

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string"
}

Response samples

Content type

application/json

{"active": true,
"created": "string",
"id": 0,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string",
"supplier_id": 0,
"updated": "string"
}

Put Supplier Shipping Method Map

Authorizations:

APIKey

path Parameters

supplier_id required	integer
shipping_method_map_id required	integer

Request Body schema: application/json

active	boolean
requested_shipping_method	string The requested shipping method on an Order to be mapped to a determinate shipping method
mapped_shipping_method	string For FBA, must be one of the following: ['Expedited', 'Priority', 'Standard']
mapped_shipping_account	string or null
mapped_shipping_carrier	string or null

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"requested_shipping_method": "string",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string"
}

Response samples

Content type

application/json

{"active": true,
"created": "string",
"id": 0,
"requested_shipping_method": "",
"mapped_shipping_method": "string",
"mapped_shipping_account": "string",
"mapped_shipping_carrier": "string",
"supplier_id": 0,
"updated": "string"
}

Task

Get Activity

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
complete	string
type	string
cart	integer
integration_id	integer
shipper_id	integer
warehouse_id	integer
start_date	string <date-time>
end_date	string <date-time>
success	string

Responses

Get Activity Count

Authorizations:

APIKey

Responses

Get New Task

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
complete	string
type	string
cart	integer
integration_id	integer
shipper_id	integer
warehouse_id	integer
start_date	string <date-time>
end_date	string <date-time>
success	string
table_key	Array of strings

Responses

Post New Task

Authorizations:

APIKey

Request Body schema: application/json

type	string
params	string
start_task	boolean
message_id	string

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"params": "string",
"start_task": true,
"message_id": "string"
}

Put New Task

Authorizations:

APIKey

Request Body schema: application/json

status	string
complete	string
success	string
error_event_id	string
s3_key	string
params	string

Responses

Request samples

Payload

Content type

application/json

{"status": "string",
"complete": "string",
"success": "string",
"error_event_id": "string",
"s3_key": "string",
"params": "string"
}

Get New Task

Authorizations:

APIKey

path Parameters

task_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
complete	string
type	string
cart	integer
integration_id	integer
shipper_id	integer
warehouse_id	integer
start_date	string <date-time>
end_date	string <date-time>
success	string
table_key	Array of strings

Responses

Post New Task

Authorizations:

APIKey

path Parameters

task_id

required

integer

Request Body schema: application/json

type	string
params	string
start_task	boolean
message_id	string

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"params": "string",
"start_task": true,
"message_id": "string"
}

Put New Task

Authorizations:

APIKey

path Parameters

task_id

required

integer

Request Body schema: application/json

status	string
complete	string
success	string
error_event_id	string
s3_key	string
params	string

Responses

Request samples

Payload

Content type

application/json

{"status": "string",
"complete": "string",
"success": "string",
"error_event_id": "string",
"s3_key": "string",
"params": "string"
}

Get New Task Data

Authorizations:

APIKey

path Parameters

task_id

required

integer

Responses

Get Task

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
complete	string
type	string
cart	integer
integration_id	integer
shipper_id	integer
warehouse_id	integer
start_date	string <date-time>
end_date	string <date-time>
success	string

Responses

Post Task

Authorizations:

APIKey

Request Body schema: application/json

cart	integer
type	string
params	string
start_task	boolean
message_id	string

Responses

Request samples

Payload

Content type

application/json

{"cart": 0,
"type": "string",
"params": "string",
"start_task": true,
"message_id": "string"
}

Put Task

Authorizations:

APIKey

Request Body schema: application/json

status	string
complete	string
success	string
error_event_id	string
s3_key	string
params	string

Responses

Request samples

Payload

Content type

application/json

{"status": "string",
"complete": "string",
"success": "string",
"error_event_id": "string",
"s3_key": "string",
"params": "string"
}

Get Task

Authorizations:

APIKey

path Parameters

task_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
complete	string
type	string
cart	integer
integration_id	integer
shipper_id	integer
warehouse_id	integer
start_date	string <date-time>
end_date	string <date-time>
success	string

Responses

Post Task

Authorizations:

APIKey

path Parameters

task_id

required

integer

Request Body schema: application/json

cart	integer
type	string
params	string
start_task	boolean
message_id	string

Responses

Request samples

Payload

Content type

application/json

{"cart": 0,
"type": "string",
"params": "string",
"start_task": true,
"message_id": "string"
}

Put Task

Authorizations:

APIKey

path Parameters

task_id

required

integer

Request Body schema: application/json

status	string
complete	string
success	string
error_event_id	string
s3_key	string
params	string

Responses

Request samples

Payload

Content type

application/json

{"status": "string",
"complete": "string",
"success": "string",
"error_event_id": "string",
"s3_key": "string",
"params": "string"
}

Post Task Retry

Authorizations:

APIKey

path Parameters

task_id

required

integer

Request Body schema: application/json

limit	integer
offset	integer
sort	Array of strings
search	string
complete	string
type	string
cart	integer
integration_id	integer
shipper_id	integer
warehouse_id	integer
start_date	string <date-time>
end_date	string <date-time>
success	string

Responses

Request samples

Payload

Content type

application/json

{"limit": 0,
"offset": 0,
"sort": ["string"
],
"search": "string",
"complete": "string",
"type": "string",
"cart": 0,
"integration_id": 0,
"shipper_id": 0,
"warehouse_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"success": "string"
}

Tracking

Get Return Tracking

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
shipper_id	integer
ship_date	string <date-time>
timezone	string
tracking	string
created_after	string
void	string

Responses

Get Return Tracking

Authorizations:

APIKey

path Parameters

return_tracking_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
shipper_id	integer
ship_date	string <date-time>
timezone	string
tracking	string
created_after	string
void	string

Responses

Get Tracking

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
shipper_id	integer
warehouse_id	integer
ship_date	string <date-time>
timezone	string
tracking	string
created_after	string
void	string

Responses

Get Tracking

Authorizations:

APIKey

path Parameters

tracking_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
shipper_id	integer
warehouse_id	integer
ship_date	string <date-time>
timezone	string
tracking	string
created_after	string
void	string

Responses

User

Delete User

Authorizations:

APIKey

Responses

Get User

Authorizations:

APIKey

Responses

Post User

Authorizations:

APIKey

Request Body schema: application/json

name	string <= 60 characters Full Name
email required	string <email> <= 75 characters Email Address
password	string [ 8 .. 128 ] characters Password
warehouse_ids	Array of numbers[ items ] Assigned Warehouses

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "user@example.com",
"password": "stringst",
"warehouse_ids": [0
]
}

Put User

Authorizations:

APIKey

Request Body schema: application/json

name	string <= 60 characters Full Name
email	string <email> <= 75 characters Email Address
password	string [ 8 .. 128 ] characters Password
warehouse_ids	Array of numbers[ items ] Assigned Warehouses
otp_seed	string or null The seed with which to create an OTP
otp	string 6 characters Used to verify otp_seed
	object Permissions
	object Settings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "user@example.com",
"password": "stringst",
"warehouse_ids": [0
],
"otp_seed": "string",
"otp": "string",
"permissions": {"order": true,
"return_order": true,
"manufacturing_order": true,
"product": true,
"purchase_order": true,
"stocktake": true,
"analytics": true,
"settings": true,
"reports": true,
"can_manage_user": true
},
"settings": { }
}

Get User Me

Authorizations:

APIKey

Responses

Delete User

Authorizations:

APIKey

path Parameters

user_id

required

integer

Responses

Get User

Authorizations:

APIKey

path Parameters

user_id

required

integer

Responses

Post User

Authorizations:

APIKey

path Parameters

user_id

required

integer

Request Body schema: application/json

name	string <= 60 characters Full Name
email required	string <email> <= 75 characters Email Address
password	string [ 8 .. 128 ] characters Password
warehouse_ids	Array of numbers[ items ] Assigned Warehouses

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "user@example.com",
"password": "stringst",
"warehouse_ids": [0
]
}

Put User

Authorizations:

APIKey

path Parameters

user_id

required

integer

Request Body schema: application/json

name	string <= 60 characters Full Name
email	string <email> <= 75 characters Email Address
password	string [ 8 .. 128 ] characters Password
warehouse_ids	Array of numbers[ items ] Assigned Warehouses
otp_seed	string or null The seed with which to create an OTP
otp	string 6 characters Used to verify otp_seed
	object Permissions
	object Settings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "user@example.com",
"password": "stringst",
"warehouse_ids": [0
],
"otp_seed": "string",
"otp": "string",
"permissions": {"order": true,
"return_order": true,
"manufacturing_order": true,
"product": true,
"purchase_order": true,
"stocktake": true,
"analytics": true,
"settings": true,
"reports": true,
"can_manage_user": true
},
"settings": { }
}

V3

Post Account Add Funds

Authorizations:

APIKey

Request Body schema: application/json

amount required	number <double>
description required	string

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"description": "string"
}

Response samples

Content type

application/json

{"apv_balance": 0,
"balance": 0,
"daily_purchase_limit": 0,
"ledger_balance": 0,
"todays_purchases": 0,
"payment_account_number": "string"
}

Get Account Balance

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"apv_balance": 0,
"balance": 0,
"daily_purchase_limit": 0,
"ledger_balance": 0,
"todays_purchases": 0,
"payment_account_number": "string"
}

Get Carrier

Authorizations:

APIKey

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
all	string

Responses

Response samples

Content type

application/json

{"archive_date": "string",
"autorefill_config": { },
"company_id": 0,
"created": "string",
"hidden_shipping_methods": [null
],
"id": 0,
"link": "string",
"name": "string",
"updated": "string",
"vendor": "string",
"vendor_config": { },
"transaction_fee": 0,
"index": null
}

Put Carrier

Authorizations:

APIKey

Request Body schema: application/json

archive_date	string or null <date-time>
hidden_shipping_methods	Array of any[ items ]
name	string
vendor_config	object Credentials required by easypost by carrier type

Responses

Request samples

Payload

Content type

application/json

{"archive_date": "2019-08-24T14:15:22Z",
"hidden_shipping_methods": [null
],
"name": "string",
"vendor_config": { }
}

Response samples

Content type

application/json

{"archive_date": "string",
"autorefill_config": { },
"company_id": 0,
"created": "string",
"hidden_shipping_methods": [null
],
"id": 0,
"link": "string",
"name": "string",
"updated": "string",
"vendor": "string",
"vendor_config": { },
"transaction_fee": 0,
"index": null
}

Post Carrier Australia Post

Authorizations:

APIKey

Request Body schema: application/json

vendor	string
vendor_config	object Credentials required by easypost by carrier type
archive_date	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"vendor": "string",
"vendor_config": { },
"archive_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"archive_date": "string",
"autorefill_config": { },
"company_id": 0,
"created": "string",
"hidden_shipping_methods": [null
],
"id": 0,
"link": "string",
"name": "string",
"updated": "string",
"vendor": "string",
"vendor_config": { },
"transaction_fee": 0,
"index": null
}

Get Carrier

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

query Parameters

limit	integer
offset	integer
sort	Array of strings
search	string
all	string

Responses

Response samples

Content type

application/json

{"archive_date": "string",
"autorefill_config": { },
"company_id": 0,
"created": "string",
"hidden_shipping_methods": [null
],
"id": 0,
"link": "string",
"name": "string",
"updated": "string",
"vendor": "string",
"vendor_config": { },
"transaction_fee": 0,
"index": null
}

Put Carrier

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

Request Body schema: application/json

archive_date	string or null <date-time>
hidden_shipping_methods	Array of any[ items ]
name	string
vendor_config	object Credentials required by easypost by carrier type

Responses

Request samples

Payload

Content type

application/json

{"archive_date": "2019-08-24T14:15:22Z",
"hidden_shipping_methods": [null
],
"name": "string",
"vendor_config": { }
}

Response samples

Content type

application/json

{"archive_date": "string",
"autorefill_config": { },
"company_id": 0,
"created": "string",
"hidden_shipping_methods": [null
],
"id": 0,
"link": "string",
"name": "string",
"updated": "string",
"vendor": "string",
"vendor_config": { },
"transaction_fee": 0,
"index": null
}

Get Charges

Authorizations:

APIKey

Responses

Post Fedex Locations

Authorizations:

APIKey

Request Body schema: application/json

required	object
required	object (v1_address) The to address is used as the destination address rate and label request.
shipper_id required	integer

Responses

Request samples

Payload

Content type

application/json

{"options": {"location_types": ["FEDEX_AUTHORIZED_SHIP_CENTER"
]
},
"ship_to": {"id": 0,
"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"_link": "string",
"_linkaddresscreatedtaskstatus": "string",
"validation": {"is_error": true,
"additional_text": "string",
"suggested": [{"city": "string",
"zip": "string",
"street1": "string",
"street2": "string",
"is_commercial": "string",
"state": "string",
"country_code": "string"
}
]
}
},
"shipper_id": 0
}

Post Fedex Document

Authorizations:

APIKey

Request Body schema: application/json

attachment required	string
document_content_type required	string Enum: "application/pdf" "application/x-soffice" "application/doc" "text/richtext" "text/rtf" "application/x-rtf" "application/rtf" "application/msword" "text/plain" "image/bmp" "image/png" "image/gif" "image/jpeg" "image/tiff" "application/vnd.openxmlformats-officedocument.wordprocessingml.document" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "application/vnd.ms-excel"
document_type required	string Enum: "CERTIFICATE_OF_ORIGIN" "COMMERCIAL_INVOICE" "OTHER" "PRO_FORMA_INVOICE"
filename required	string
ship_date	string
shipper_id required	integer
ship_from_country required	string
ship_to_country required	string

Responses

Request samples

Payload

Content type

application/json

{"attachment": "string",
"document_content_type": "application/pdf",
"document_type": "CERTIFICATE_OF_ORIGIN",
"filename": "string",
"ship_date": "string",
"shipper_id": 0,
"ship_from_country": "string",
"ship_to_country": "string"
}

Get Net Zero Charges

Authorizations:

APIKey

Responses

Post Pickup Fedex

Authorizations:

APIKey

Request Body schema: application/json

close_time required	string
pickup_address_same_as_account	boolean Deprecated: Indicates whether to use the address associated with the Fedex account, or a different address
oversize_package_count	integer Default: 0
package_location	string Enum: "FRONT" "NONE" "REAR" "SIDE"
pickup_datetime required	string
pickup_date_type	string Enum: "SAME_DAY" "FUTURE_DAY"
quantity required	integer
total_weight required	number total weight of packages in pounds (LB)
service_category	string Enum: "SAME_DAY" "SAME_DAY_CITY" "FEDEX_DISTANCE_DEFERRED" "FEDEX_NEXT_DAY_EARLY_MORNING" "FEDEX_NEXT_DAY_MID_MORNING" "FEDEX_NEXT_DAY_AFTERNOON" "FEDEX_NEXT_DAY_END_OF_DAY" "FEDEX_NEXT_DAY_FREIGHT"
carrier_code	string Enum: "FDXG" "FDXE" Describes the fedex carrier for the pickup: ['FDXG' - Fedex Ground, 'FDXE' - Fedex Express]
remarks	string Identifies comments the customer wants to convey to the FedEx courier regarding the package pickup.
shipper_id required	integer
warehouse_id	integer warehouse for the pickup address
commodity_description	string Provides area for any additional commodity description
domestic_or_international	string Default: "DOMESTIC" Enum: "DOMESTIC" "INTERNATIONAL" Describes the country relationship (domestic and/or international) among the shipments being picked up

Responses

Request samples

Payload

Content type

application/json

{"close_time": "string",
"pickup_address_same_as_account": true,
"oversize_package_count": 0,
"package_location": "FRONT",
"pickup_datetime": "string",
"pickup_date_type": "SAME_DAY",
"quantity": 0,
"total_weight": 0,
"service_category": "SAME_DAY",
"carrier_code": "FDXG",
"remarks": "string",
"shipper_id": 0,
"warehouse_id": 0,
"commodity_description": "string",
"domestic_or_international": "DOMESTIC"
}

Response samples

Content type

application/json

{"pickup_address": {"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"validate": true,
"set_revision_lock": true,
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"pickup_address_same_as_account": true,
"pickup_datetime": "2019-08-24T14:15:22Z",
"close_time": "2019-08-24T14:15:22Z",
"location": "string",
"pickup_number": "string",
"cost": "string",
"carrier": "ups",
"carrier_options": { }
}

Post Pickup U P S

Authorizations:

APIKey

Request Body schema: application/json

shipper_id required	integer
close_time required	string
overweight_packages	boolean Default: false
pickup_address_same_as_account required	boolean
pickup_datetime required	string <date-time>
required	Array of objects[ items ]
shipper_country	string
warehouse_id required	integer warehouse for the pickup address

Responses

Request samples

Payload

Content type

application/json

{"shipper_id": 0,
"close_time": "string",
"overweight_packages": false,
"pickup_address_same_as_account": true,
"pickup_datetime": "2019-08-24T14:15:22Z",
"pickup_pieces": [{"container_type": "01",
"destination_country": "string",
"service_type": "string",
"quantity": 0
}
],
"shipper_country": "string",
"warehouse_id": 0
}

Response samples

Content type

application/json

{"pickup_address": {"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"validate": true,
"set_revision_lock": true,
"validation": {"status": "unvalidated",
"suggested": [{"is_commercial": false,
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string"
}
],
"additional_text": "string",
"is_error": true
}
},
"pickup_address_same_as_account": true,
"pickup_datetime": "2019-08-24T14:15:22Z",
"close_time": "2019-08-24T14:15:22Z",
"location": "string",
"pickup_number": "string",
"cost": "string",
"carrier": "ups",
"carrier_options": { }
}

Get Shipper Balance

Authorizations:

APIKey

path Parameters

shipper_id

required

string

Responses

Response samples

Content type

application/json

Example

Account Balance Response Schema

{"apv_balance": 0,
"balance": 0,
"daily_purchase_limit": 0,
"ledger_balance": 0,
"todays_purchases": 0,
"payment_account_number": "string"
}

Post Shipper Balance

Authorizations:

APIKey

path Parameters

shipper_id

required

string

Request Body schema: application/json

amount

required

number <double> >= 10

Responses

Request samples

Payload

Content type

application/json

{"amount": 10
}

Response samples

Content type

application/json

{"postage_balance": 0,
"postage_printed": 0
}

Get Shippo Carriers

Authorizations:

APIKey

path Parameters

shipper_id

required

integer

query Parameters

shipping_methods

boolean

Responses

Warehouse

Get Warehouse

Authorizations:

APIKey

query Parameters

sort	Array of strings Items Value: "name"
is_default	boolean

Responses

Post Warehouse

Authorizations:

APIKey

Request Body schema: application/json

company	string <= 255 characters
name	string <= 255 characters
street1	string <= 255 characters
street2	string <= 255 characters
city	string <= 255 characters
state	string <= 255 characters
zip	string <= 255 characters
country	string <= 255 characters
email	string <= 255 characters
email_cc	string <= 255 characters
email_bcc	string <= 255 characters
phone	string <= 255 characters
fax	string <= 255 characters
reference_number	string <= 255 characters
cart_address_id	string <= 255 characters
validation	string
cart_id	string <= 255 characters
warehouse_type	string Enum: "awd" "fba"

Responses

Request samples

Payload

Content type

application/json

{"company": "string",
"name": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"validation": "string",
"cart_id": "string",
"warehouse_type": "awd"
}

Put Warehouse

Authorizations:

APIKey

Request Body schema: application/json

company	string <= 255 characters
name	string <= 255 characters
street1	string <= 255 characters
street2	string <= 255 characters
city	string <= 255 characters
state	string <= 255 characters
zip	string <= 255 characters
country	string <= 255 characters
email	string <= 255 characters
email_cc	string <= 255 characters
email_bcc	string <= 255 characters
phone	string <= 255 characters
fax	string <= 255 characters
reference_number	string <= 255 characters
cart_address_id	string <= 255 characters
validation	string
cart_id	string <= 255 characters
warehouse_type	string Enum: "awd" "fba"

Responses

Request samples

Payload

Content type

application/json

{"company": "string",
"name": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"validation": "string",
"cart_id": "string",
"warehouse_type": "awd"
}

Get Warehouse

Authorizations:

APIKey

path Parameters

warehouse_id

required

integer

Responses

Post Warehouse

Authorizations:

APIKey

path Parameters

warehouse_id

required

integer

Request Body schema: application/json

company	string <= 255 characters
name	string <= 255 characters
street1	string <= 255 characters
street2	string <= 255 characters
city	string <= 255 characters
state	string <= 255 characters
zip	string <= 255 characters
country	string <= 255 characters
email	string <= 255 characters
email_cc	string <= 255 characters
email_bcc	string <= 255 characters
phone	string <= 255 characters
fax	string <= 255 characters
reference_number	string <= 255 characters
cart_address_id	string <= 255 characters
validation	string
cart_id	string <= 255 characters
warehouse_type	string Enum: "awd" "fba"

Responses

Request samples

Payload

Content type

application/json

{"company": "string",
"name": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"validation": "string",
"cart_id": "string",
"warehouse_type": "awd"
}

Put Warehouse

Authorizations:

APIKey

path Parameters

warehouse_id

required

integer

Request Body schema: application/json

company	string <= 255 characters
name	string <= 255 characters
street1	string <= 255 characters
street2	string <= 255 characters
city	string <= 255 characters
state	string <= 255 characters
zip	string <= 255 characters
country	string <= 255 characters
email	string <= 255 characters
email_cc	string <= 255 characters
email_bcc	string <= 255 characters
phone	string <= 255 characters
fax	string <= 255 characters
reference_number	string <= 255 characters
cart_address_id	string <= 255 characters
validation	string
cart_id	string <= 255 characters
warehouse_type	string Enum: "awd" "fba"

Responses

Request samples

Payload

Content type

application/json

{"company": "string",
"name": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string",
"email_cc": "string",
"email_bcc": "string",
"phone": "string",
"fax": "string",
"reference_number": "string",
"cart_address_id": "string",
"validation": "string",
"cart_id": "string",
"warehouse_type": "awd"
}

Post Warehouse Make Default

Authorizations:

APIKey

path Parameters

warehouse_id

required

integer

Responses

Workflow

Delete Workflow

Authorizations:

APIKey

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}

Get Workflow

Authorizations:

APIKey

query Parameters

limit	integer Default: 10
offset	integer Default: 0
reference_id	string

Responses

Response samples

Content type

application/json

{"workflows": [{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}
],
"limit": 10,
"offset": 0,
"count": 0
}

Post Workflow

Authorizations:

APIKey

Request Body schema: application/json

reference_id required	string Workflow name
constants	object An optional dictionary of workflow constants
to_encrypt	array An optional string array of workflow constants to encrypt - for sensitive information like credentials
frequency required	string

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"constants": { },
"to_encrypt": [ ],
"frequency": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}

Put Workflow

Authorizations:

APIKey

Request Body schema: application/json

active	boolean Boolean to set script as active or inactive
to_encrypt	array A string array of constants to encrypt. New constants to encrypt and/or constants to keep encrypted must be sent in every PUT request
delete_constants	array A string array of constants to delete from workflow
put_constants	object A dictionary of constants to add to workflow
frequency	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"to_encrypt": [ ],
"delete_constants": [ ],
"put_constants": { },
"frequency": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}

Delete Workflow

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}

Get Workflow

Authorizations:

APIKey

path Parameters

reference_id

required

string

Responses

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}

Post Workflow

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

reference_id required	string Workflow name
constants	object An optional dictionary of workflow constants
to_encrypt	array An optional string array of workflow constants to encrypt - for sensitive information like credentials
frequency required	string

Responses

Request samples

Payload

Content type

application/json

{"reference_id": "string",
"constants": { },
"to_encrypt": [ ],
"frequency": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}

Put Workflow

Authorizations:

APIKey

path Parameters

reference_id

required

string

Request Body schema: application/json

active	boolean Boolean to set script as active or inactive
to_encrypt	array A string array of constants to encrypt. New constants to encrypt and/or constants to keep encrypted must be sent in every PUT request
delete_constants	array A string array of constants to delete from workflow
put_constants	object A dictionary of constants to add to workflow
frequency	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"to_encrypt": [ ],
"delete_constants": [ ],
"put_constants": { },
"frequency": "string"
}

Response samples

Content type

application/json

{"reference_id": "string",
"created_date": "string",
"updated_date": "string",
"constants": { },
"active": true,
"encrypted_constants": [ ],
"frequency": "string"
}