Place or change a hold

Places a hold of this type on the order, or changes the date of the one it already has. Repeating a request changes nothing. A HOLD_UNTIL hold is the one specialInstructions.shipDate reads and writes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

A kind of hold. An order has at most one hold of each type. More types will be added: a client should accept a value it doesn't know.

Allowed:
string
required
Body Params

Places a hold of a type, or changes the one the order already has

date
required

The date the hold lifts. Must be in the future.

Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json