API Reference

Place or change a hold

put
https://vinoshipper.com/api/v3/p/orders//holds/

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

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.

string | null

A comment on the hold, up to 250 characters. Omit to keep the one it has, or send null to clear it.

string | null
enum

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:
Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Updated 27 days ago

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

Updated 27 days ago

Did this page help you?