API Reference

Create an Order

post
https://vinoshipper.com/api/v3/p/orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Optional order number to use instead of generating one

string

Optional link to the order in the source system

customer
object
shipToAddress
object

Where the order will be shipped to

string
enum

The type of productId used in the request to identify orders in our system

Allowed:
products
array of objects
required

A list of products that will go on the order

products*
shippingRate
object

The shipping rate that will be used to ship the order. You can call the Estimate Shipping API to get a list of shipping rates for a specific address. You can also call the Get Shipping Rate Codes API to get a list of all possible rate codes for the producer.

number

When collecting money directly from the customer, you may collect a different tax amount than Vinoshipper calculates. If the custom tax amount is less than Vinoshipper calculates, the producer will be charged the difference. If the custom tax amount is greater than Vinoshipper calculates, the producer will be responsible for refunding the difference to the customer.

number

Vinoshipper calculates additional fees, such as CO Retail Delivery fees and CA container deposit fees.If your system collects these fees they should be passed here so that Vinoshipper does not try to collect those fees from the producer. The value of this field will be compared to the total extra fees that Vinoshipper calculated and if you under charged fees they will collected from you during payout.

number

Amount of tip added to the order

discount
object
metaFields
object

A list of key value pairs to attach as metadata to this order.

specialInstructions
object
boolean

Disable all customer communications about this order. This includes things like the order confirmation email as well as order shipping status notifications.

boolean

Complete this order and mark it as paid. This money will be collected from the producer.

int32

Store id for the order (default will be used if null)

int32

Shipper id to use for this order (default will be used if null)

string
length between 0 and 255

The fulfillment account or route name to use when the producer allows multiple external fulfillment options. Most producers will not use this field.

soldBy
object

The Vinoshipper team member information

boolean
deprecated

This field is deprecated, please use the paid field (without "is" prefix)

customerNotificationPreferences
object

Granular email notification preferences that override the global disableCustomerNotifications setting. Allows independent control of specific notification types.

Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Updated 8 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 8 months ago