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>"
}
]
}
'import requests
url = "https://api.example.com/api/v1/Orders/SubmitOrders"
payload = {
"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>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
}
]
})
};
fetch('https://api.example.com/api/v1/Orders/SubmitOrders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/Orders/SubmitOrders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/Orders/SubmitOrders"
payload := strings.NewReader("{\n \"accountNumber\": \"<string>\",\n \"password\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"orders\": [\n {\n \"customerOrderId\": \"<string>\",\n \"orderType\": \"<string>\",\n \"isOnSitePurchase\": \"false\",\n \"shippingPriority\": \"<string>\",\n \"consumerHandlingFeeOrShippingHandling\": 123,\n \"consumerShippingCharge\": 123,\n \"salesTaxAmount\": 123,\n \"totalChargeToConsumer\": 123,\n \"soldToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"notificationCode\": \"<string>\",\n \"packingSlipCode\": \"<string>\",\n \"shippingInstructions\": \"<string>\",\n \"giftMessage\": \"<string>\",\n \"reference1\": \"<string>\",\n \"reference2\": \"<string>\",\n \"reference3\": \"<string>\",\n \"consumerInsurance\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ],\n \"lineItems\": [\n {\n \"lineNumber\": \"<string>\",\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"shipToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverAddressType\": \"<string>\",\n \"soldToId\": \"<string>\",\n \"shipToId\": \"<string>\",\n \"deliveryAddressId\": \"<string>\",\n \"deliveryToConsumerId\": \"<string>\",\n \"soldToPhone\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"deliverToPhone\": \"<string>\",\n \"soldToEmail\": \"<string>\",\n \"shipToEmail\": \"<string>\",\n \"deliverToEmail\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/Orders/SubmitOrders")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accountNumber\": \"<string>\",\n \"password\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"orders\": [\n {\n \"customerOrderId\": \"<string>\",\n \"orderType\": \"<string>\",\n \"isOnSitePurchase\": \"false\",\n \"shippingPriority\": \"<string>\",\n \"consumerHandlingFeeOrShippingHandling\": 123,\n \"consumerShippingCharge\": 123,\n \"salesTaxAmount\": 123,\n \"totalChargeToConsumer\": 123,\n \"soldToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"notificationCode\": \"<string>\",\n \"packingSlipCode\": \"<string>\",\n \"shippingInstructions\": \"<string>\",\n \"giftMessage\": \"<string>\",\n \"reference1\": \"<string>\",\n \"reference2\": \"<string>\",\n \"reference3\": \"<string>\",\n \"consumerInsurance\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ],\n \"lineItems\": [\n {\n \"lineNumber\": \"<string>\",\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"shipToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverAddressType\": \"<string>\",\n \"soldToId\": \"<string>\",\n \"shipToId\": \"<string>\",\n \"deliveryAddressId\": \"<string>\",\n \"deliveryToConsumerId\": \"<string>\",\n \"soldToPhone\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"deliverToPhone\": \"<string>\",\n \"soldToEmail\": \"<string>\",\n \"shipToEmail\": \"<string>\",\n \"deliverToEmail\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Orders/SubmitOrders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountNumber\": \"<string>\",\n \"password\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"orders\": [\n {\n \"customerOrderId\": \"<string>\",\n \"orderType\": \"<string>\",\n \"isOnSitePurchase\": \"false\",\n \"shippingPriority\": \"<string>\",\n \"consumerHandlingFeeOrShippingHandling\": 123,\n \"consumerShippingCharge\": 123,\n \"salesTaxAmount\": 123,\n \"totalChargeToConsumer\": 123,\n \"soldToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"notificationCode\": \"<string>\",\n \"packingSlipCode\": \"<string>\",\n \"shippingInstructions\": \"<string>\",\n \"giftMessage\": \"<string>\",\n \"reference1\": \"<string>\",\n \"reference2\": \"<string>\",\n \"reference3\": \"<string>\",\n \"consumerInsurance\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ],\n \"lineItems\": [\n {\n \"lineNumber\": \"<string>\",\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"shipToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverAddressType\": \"<string>\",\n \"soldToId\": \"<string>\",\n \"shipToId\": \"<string>\",\n \"deliveryAddressId\": \"<string>\",\n \"deliveryToConsumerId\": \"<string>\",\n \"soldToPhone\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"deliverToPhone\": \"<string>\",\n \"soldToEmail\": \"<string>\",\n \"shipToEmail\": \"<string>\",\n \"deliverToEmail\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": {
"notifications": [
{
"message": "<string>",
"kind": "NotSet",
"sourceOfNotification": "<string>"
}
],
"isSuccess": true,
"isWarning": true
}
}Uploads many orders all at once in a batch into a queue which can take 15 minutes to process.
This functionality closely mirrors the WineDirect Portal’s Bulk Upload. Please visit:
https://fulfillment.winedirect.com/orders/upload for more details
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>"
}
]
}
'import requests
url = "https://api.example.com/api/v1/Orders/SubmitOrders"
payload = {
"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>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
}
]
})
};
fetch('https://api.example.com/api/v1/Orders/SubmitOrders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/Orders/SubmitOrders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/Orders/SubmitOrders"
payload := strings.NewReader("{\n \"accountNumber\": \"<string>\",\n \"password\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"orders\": [\n {\n \"customerOrderId\": \"<string>\",\n \"orderType\": \"<string>\",\n \"isOnSitePurchase\": \"false\",\n \"shippingPriority\": \"<string>\",\n \"consumerHandlingFeeOrShippingHandling\": 123,\n \"consumerShippingCharge\": 123,\n \"salesTaxAmount\": 123,\n \"totalChargeToConsumer\": 123,\n \"soldToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"notificationCode\": \"<string>\",\n \"packingSlipCode\": \"<string>\",\n \"shippingInstructions\": \"<string>\",\n \"giftMessage\": \"<string>\",\n \"reference1\": \"<string>\",\n \"reference2\": \"<string>\",\n \"reference3\": \"<string>\",\n \"consumerInsurance\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ],\n \"lineItems\": [\n {\n \"lineNumber\": \"<string>\",\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"shipToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverAddressType\": \"<string>\",\n \"soldToId\": \"<string>\",\n \"shipToId\": \"<string>\",\n \"deliveryAddressId\": \"<string>\",\n \"deliveryToConsumerId\": \"<string>\",\n \"soldToPhone\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"deliverToPhone\": \"<string>\",\n \"soldToEmail\": \"<string>\",\n \"shipToEmail\": \"<string>\",\n \"deliverToEmail\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/Orders/SubmitOrders")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accountNumber\": \"<string>\",\n \"password\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"orders\": [\n {\n \"customerOrderId\": \"<string>\",\n \"orderType\": \"<string>\",\n \"isOnSitePurchase\": \"false\",\n \"shippingPriority\": \"<string>\",\n \"consumerHandlingFeeOrShippingHandling\": 123,\n \"consumerShippingCharge\": 123,\n \"salesTaxAmount\": 123,\n \"totalChargeToConsumer\": 123,\n \"soldToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"notificationCode\": \"<string>\",\n \"packingSlipCode\": \"<string>\",\n \"shippingInstructions\": \"<string>\",\n \"giftMessage\": \"<string>\",\n \"reference1\": \"<string>\",\n \"reference2\": \"<string>\",\n \"reference3\": \"<string>\",\n \"consumerInsurance\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ],\n \"lineItems\": [\n {\n \"lineNumber\": \"<string>\",\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"shipToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverAddressType\": \"<string>\",\n \"soldToId\": \"<string>\",\n \"shipToId\": \"<string>\",\n \"deliveryAddressId\": \"<string>\",\n \"deliveryToConsumerId\": \"<string>\",\n \"soldToPhone\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"deliverToPhone\": \"<string>\",\n \"soldToEmail\": \"<string>\",\n \"shipToEmail\": \"<string>\",\n \"deliverToEmail\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Orders/SubmitOrders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountNumber\": \"<string>\",\n \"password\": \"<string>\",\n \"batchNumber\": \"<string>\",\n \"orders\": [\n {\n \"customerOrderId\": \"<string>\",\n \"orderType\": \"<string>\",\n \"isOnSitePurchase\": \"false\",\n \"shippingPriority\": \"<string>\",\n \"consumerHandlingFeeOrShippingHandling\": 123,\n \"consumerShippingCharge\": 123,\n \"salesTaxAmount\": 123,\n \"totalChargeToConsumer\": 123,\n \"soldToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"notificationCode\": \"<string>\",\n \"packingSlipCode\": \"<string>\",\n \"shippingInstructions\": \"<string>\",\n \"giftMessage\": \"<string>\",\n \"reference1\": \"<string>\",\n \"reference2\": \"<string>\",\n \"reference3\": \"<string>\",\n \"consumerInsurance\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ],\n \"lineItems\": [\n {\n \"lineNumber\": \"<string>\",\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"vasOrderPersonalizations\": [\n {\n \"type\": \"<string>\",\n \"lineNumber\": 123,\n \"message\": \"<string>\",\n \"options\": [\n {\n \"type\": \"<string>\",\n \"option\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"shipToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverToAddress\": {\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"US\"\n },\n \"deliverAddressType\": \"<string>\",\n \"soldToId\": \"<string>\",\n \"shipToId\": \"<string>\",\n \"deliveryAddressId\": \"<string>\",\n \"deliveryToConsumerId\": \"<string>\",\n \"soldToPhone\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"deliverToPhone\": \"<string>\",\n \"soldToEmail\": \"<string>\",\n \"shipToEmail\": \"<string>\",\n \"deliverToEmail\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": {
"notifications": [
{
"message": "<string>",
"kind": "NotSet",
"sourceOfNotification": "<string>"
}
],
"isSuccess": true,
"isWarning": true
}
}Warehouse selection
ThewarehouseCode field on each order in the request body is optional.
- The values (
GLW,WDI,PSO,SMA,SHW,DAL) refer to WineDirect’s own fulfillment centers. They map to Glenwillow, Green Island, Paso Robles, Santa Maria, Willamette Valley, and Dallas. They do not represent a customer’s private warehouse. - If you leave
warehouseCodenull, WineDirect applies the Warehouse Selection Rules configured on your account to pick a fulfillment center based on the destination state. - Set
warehouseCodeexplicitly only when you need to override those rules and force a specific WineDirect fulfillment center.
To pull order data back out after submission, use
GET /api/v1/Orders for order summaries by accountNumber, or GET /api/v1/Orders/Detail/{accountNumber}/{orderNumber} for the full detail of a single order.Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Body
application/json
Detail about a group of orders to import
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:
1The importer's password
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:
240Detail about the orders to import
Show child attributes
Show child attributes
Was this page helpful?