Gets the full detail about an order
curl --request GET \
--url https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber} \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}', 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/Detail/{accountNumber}/{orderNumber}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": {
"header": {
"accountNumber": "<string>",
"customerName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"wineDirectOrderNumber": "<string>",
"orderNumber": "<string>",
"receivedDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"customerOrderDate": "2023-11-07T05:31:56Z",
"requestedShipDate": "2023-11-07T05:31:56Z",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"shippedDate": "2023-11-07T05:31:56Z",
"batchNumber": "<string>",
"orderTypeCode": "<string>",
"orderTypeName": "<string>",
"requestedServiceLevel": "<string>",
"plannedServiceLevel": "<string>",
"orderStatusCode": "<string>",
"orderStatusName": "<string>",
"collapsedStatus": "<string>",
"notificationEmail": "<string>",
"notificationPhone": "<string>",
"giftMessage": "<string>",
"shippingInstructions": "<string>",
"complianceRoute": "<string>",
"fulfillmentRoute": "<string>",
"packingSlipCode": "<string>",
"packingSlipName": "<string>",
"isOnsitePurchase": true,
"isLineHaul": true,
"isEditable": true,
"isCancellable": true,
"isBackOrdered": true,
"hasInventoryHold": true,
"slaStatusCode": "<string>",
"slaStatusName": "<string>",
"slaDate": "2023-11-07T05:31:56Z",
"notificationTemplateCode": "<string>",
"notificationTemplateName": "<string>",
"packagingTypeCode": "<string>",
"packagingTypeName": "<string>",
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
},
"holds": [
{
"holdStatus": "<string>",
"holdName": "<string>",
"holdDescription": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"holdComment": "<string>",
"releaseDate": "2023-11-07T05:31:56Z",
"releaseReason": "<string>",
"releaseComment": "<string>",
"isDirectlyReleasable": true
}
],
"messages": [
{
"messageType": "<string>",
"messageTime": "2023-11-07T05:31:56Z",
"message": "<string>"
}
],
"soldToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>"
}
],
"shipToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"deliverToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"lineItems": [
{
"lineNumber": "<string>",
"componentNumber": "<string>",
"inventoryItemId": "<string>",
"sku": "<string>",
"description": "<string>",
"isShippable": true,
"quantityOrdered": 123,
"uom": "<string>",
"unitPrice": 123,
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"quantityReserved": 123,
"quantityShipped": 123,
"isBomComponent": true,
"itemShortage": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
],
"packages": [
{
"shipmentKey": "<string>",
"shipperOfRecord": "<string>",
"carrierName": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"trackingNumber": "<string>",
"carrierHttpLink": "<string>",
"packageWeight": 123,
"deliveryStatusName": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"exceptionCount": 123,
"returnDate": "2023-11-07T05:31:56Z",
"returnReason": "<string>",
"emailProcessMessage": "<string>"
}
],
"contents": [
{
"shipmentKey": "<string>",
"sku": "<string>",
"description": "<string>",
"quantityOrdered": 123,
"quantityShipped": 123,
"quantityReturned": 123,
"quantityDamaged": 123,
"quantityMissing": 123
}
],
"trackings": [
{
"shipmentKey": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"eventCity": "<string>",
"eventState": "<string>",
"eventPostalCode": "<string>",
"eventCode": "<string>",
"eventName": "<string>",
"isException": true,
"eventComments": "<string>"
}
],
"notes": [
{
"shipmentKey": "<string>",
"notes": "<string>"
}
],
"billings": [
{
"invoicingDate": "2023-11-07T05:31:56Z",
"printedInvoiceNumber": "<string>",
"lineNumber": "<string>",
"invoiceNumber": "<string>",
"description": "<string>",
"lineQuantity": 123,
"lineSubtotal": 123
}
],
"accountPayableHeaders": [
{
"invoiceKey": "<string>",
"invoiceNum": "<string>",
"payTo": "<string>",
"description": "<string>",
"invoiceAmount": 123
}
],
"accountPayableLines": [
{
"invoiceKey": "<string>",
"lineNumber": "<string>",
"sku": "<string>",
"paymentType": "<string>",
"paymentAmount": 123
}
]
}
}Gets the full detail about an order
GET
/
api
/
v1
/
Orders
/
Detail
/
{accountNumber}
/
{orderNumber}
Gets the full detail about an order
curl --request GET \
--url https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber} \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}', 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/Detail/{accountNumber}/{orderNumber}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Orders/Detail/{accountNumber}/{orderNumber}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": {
"header": {
"accountNumber": "<string>",
"customerName": "<string>",
"warehouseCode": "<string>",
"warehouseName": "<string>",
"wineDirectOrderNumber": "<string>",
"orderNumber": "<string>",
"receivedDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"customerOrderDate": "2023-11-07T05:31:56Z",
"requestedShipDate": "2023-11-07T05:31:56Z",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"shippedDate": "2023-11-07T05:31:56Z",
"batchNumber": "<string>",
"orderTypeCode": "<string>",
"orderTypeName": "<string>",
"requestedServiceLevel": "<string>",
"plannedServiceLevel": "<string>",
"orderStatusCode": "<string>",
"orderStatusName": "<string>",
"collapsedStatus": "<string>",
"notificationEmail": "<string>",
"notificationPhone": "<string>",
"giftMessage": "<string>",
"shippingInstructions": "<string>",
"complianceRoute": "<string>",
"fulfillmentRoute": "<string>",
"packingSlipCode": "<string>",
"packingSlipName": "<string>",
"isOnsitePurchase": true,
"isLineHaul": true,
"isEditable": true,
"isCancellable": true,
"isBackOrdered": true,
"hasInventoryHold": true,
"slaStatusCode": "<string>",
"slaStatusName": "<string>",
"slaDate": "2023-11-07T05:31:56Z",
"notificationTemplateCode": "<string>",
"notificationTemplateName": "<string>",
"packagingTypeCode": "<string>",
"packagingTypeName": "<string>",
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
},
"holds": [
{
"holdStatus": "<string>",
"holdName": "<string>",
"holdDescription": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"creationDate": "2023-11-07T05:31:56Z",
"holdComment": "<string>",
"releaseDate": "2023-11-07T05:31:56Z",
"releaseReason": "<string>",
"releaseComment": "<string>",
"isDirectlyReleasable": true
}
],
"messages": [
{
"messageType": "<string>",
"messageTime": "2023-11-07T05:31:56Z",
"message": "<string>"
}
],
"soldToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>"
}
],
"shipToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"deliverToConsumers": [
{
"isResidentialAddress": true,
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"deliveryStatusCode": "<string>",
"deliveryStatusName": "<string>",
"deliveryAddressTypeCode": "<string>",
"deliveryAddressTypeName": "<string>"
}
],
"lineItems": [
{
"lineNumber": "<string>",
"componentNumber": "<string>",
"inventoryItemId": "<string>",
"sku": "<string>",
"description": "<string>",
"isShippable": true,
"quantityOrdered": 123,
"uom": "<string>",
"unitPrice": 123,
"subInventoryCode": "<string>",
"subInventoryName": "<string>",
"quantityReserved": 123,
"quantityShipped": 123,
"isBomComponent": true,
"itemShortage": 123,
"vasOrderPersonalizations": [
{
"type": "<string>",
"lineNumber": 123,
"message": "<string>",
"options": [
{
"type": "<string>",
"option": "<string>",
"message": "<string>"
}
]
}
]
}
],
"packages": [
{
"shipmentKey": "<string>",
"shipperOfRecord": "<string>",
"carrierName": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"trackingNumber": "<string>",
"carrierHttpLink": "<string>",
"packageWeight": 123,
"deliveryStatusName": "<string>",
"deliveryDate": "2023-11-07T05:31:56Z",
"exceptionCount": 123,
"returnDate": "2023-11-07T05:31:56Z",
"returnReason": "<string>",
"emailProcessMessage": "<string>"
}
],
"contents": [
{
"shipmentKey": "<string>",
"sku": "<string>",
"description": "<string>",
"quantityOrdered": 123,
"quantityShipped": 123,
"quantityReturned": 123,
"quantityDamaged": 123,
"quantityMissing": 123
}
],
"trackings": [
{
"shipmentKey": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"eventCity": "<string>",
"eventState": "<string>",
"eventPostalCode": "<string>",
"eventCode": "<string>",
"eventName": "<string>",
"isException": true,
"eventComments": "<string>"
}
],
"notes": [
{
"shipmentKey": "<string>",
"notes": "<string>"
}
],
"billings": [
{
"invoicingDate": "2023-11-07T05:31:56Z",
"printedInvoiceNumber": "<string>",
"lineNumber": "<string>",
"invoiceNumber": "<string>",
"description": "<string>",
"lineQuantity": 123,
"lineSubtotal": 123
}
],
"accountPayableHeaders": [
{
"invoiceKey": "<string>",
"invoiceNum": "<string>",
"payTo": "<string>",
"description": "<string>",
"invoiceAmount": 123
}
],
"accountPayableLines": [
{
"invoiceKey": "<string>",
"lineNumber": "<string>",
"sku": "<string>",
"paymentType": "<string>",
"paymentAmount": 123
}
]
}
}Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Was this page helpful?
⌘I