Create an Order

This is the primary endpoint for submitting orders to Vinoshipper. If the order is successfully submitted, it will be recorded in your Vinoshipper account and included in all appropriate tax and compliance reports. If the order is not compliant for any reason, it will be rejected with a list of compliance problems. A rejected order can be corrected and then re-submitted via the Create or Update Order API.

If you do not provide an order number, Vinoshipper will generate one automatically. If you want to provide an order number to maintain consistency with the source system, Vinoshipper will accept most alphanumeric string formats, but it must be globally unique. If the order numbers in your source system are simple incrementing numerical IDs eg: 1234, we recommend adding a prefix or suffix with some sort of client identifier to reduce the chance of collisions.

Products must already be registered and approved within Vinoshipper to be included in an order; when submitting an order you can identify products either by the Vinoshipper product ID or SKU. To indicate which ID format you are using, set the productIdType to either SKU or VS_ID.

If funds are captured in another system, submit the order with isPaid=true.

Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!