Skip to main content
POST
/
api
/
v1
/
Orders
/
SubmitOrders
Uploads many orders all at once in a batch into a queue which can take 15 minutes to process. 
curl --request POST \
  --url https://api.example.com/api/v1/Orders/SubmitOrders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountNumber": "<string>",
  "password": "<string>",
  "batchNumber": "<string>",
  "orders": [
    {
      "customerOrderId": "<string>",
      "orderType": "<string>",
      "isOnSitePurchase": "false",
      "shippingPriority": "<string>",
      "consumerHandlingFeeOrShippingHandling": 123,
      "consumerShippingCharge": 123,
      "salesTaxAmount": 123,
      "totalChargeToConsumer": 123,
      "soldToAddress": {
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "companyName": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "city": "<string>",
        "stateOrProvince": "<string>",
        "postalCode": "<string>",
        "countryCode": "US"
      },
      "requestedShipDate": "2023-11-07T05:31:56Z",
      "warehouseCode": "<string>",
      "subInventoryCode": "<string>",
      "notificationCode": "<string>",
      "packingSlipCode": "<string>",
      "shippingInstructions": "<string>",
      "giftMessage": "<string>",
      "reference1": "<string>",
      "reference2": "<string>",
      "reference3": "<string>",
      "consumerInsurance": 123,
      "vasOrderPersonalizations": [
        {
          "type": "<string>",
          "lineNumber": 123,
          "message": "<string>",
          "options": [
            {
              "type": "<string>",
              "option": "<string>",
              "message": "<string>"
            }
          ]
        }
      ],
      "lineItems": [
        {
          "lineNumber": "<string>",
          "sku": "<string>",
          "quantity": 123,
          "unitPrice": 123,
          "vasOrderPersonalizations": [
            {
              "type": "<string>",
              "lineNumber": 123,
              "message": "<string>",
              "options": [
                {
                  "type": "<string>",
                  "option": "<string>",
                  "message": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "shipToAddress": {
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "companyName": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "city": "<string>",
        "stateOrProvince": "<string>",
        "postalCode": "<string>",
        "countryCode": "US"
      },
      "deliverToAddress": {
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "companyName": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "city": "<string>",
        "stateOrProvince": "<string>",
        "postalCode": "<string>",
        "countryCode": "US"
      },
      "deliverAddressType": "<string>",
      "soldToId": "<string>",
      "shipToId": "<string>",
      "deliveryAddressId": "<string>",
      "deliveryToConsumerId": "<string>",
      "soldToPhone": "<string>",
      "shipToPhone": "<string>",
      "deliverToPhone": "<string>",
      "soldToEmail": "<string>",
      "shipToEmail": "<string>",
      "deliverToEmail": "<string>"
    }
  ]
}
'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": {
    "notifications": [
      {
        "message": "<string>",
        "kind": "NotSet",
        "sourceOfNotification": "<string>"
      }
    ],
    "isSuccess": true,
    "isWarning": true
  }
}

Authorizations

​
Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Body

application/json

Detail about a group of orders to import

​
accountNumber
string
required

Account number that is connected to the customer account the request is related to. The account number is assigned by WineDirect during onboarding.

Minimum string length: 1
​
password
string | null

The importer's password

​
batchNumber
string | null

An identifier that is shared among a group of orders. Often used to identify a specific club batch. If not submitted the system will automatically assign a unique BatchId for each request. The assigned batch id is based on a time stamp

Maximum string length: 240
​
orders
object[] | null

Detail about the orders to import

Response

200 - application/json

OK

Generic container for all service responses

​
isSuccess
boolean

Was the request successful. If not, the message will have more information.

​
message
string | null

Any error message

​
payload
object