Get Order Information

Warning

This documentation is for translated APIs and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before making this call, as you will experience errors if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard API documentation instead.

The Get Order API retrieves information about an order. The request requires for the order to have been placed, so the Create Order API must have been called first.

The data returned by this request is the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

Production URL	https://{tenantId}-translation.mozu.com/api/v2/order/{orderID}
Sandbox URL	https://{tenantId}-translation.sandbox.mozu.com/api/v2/order/{orderID}
Supported Formats	JSON
HTTP Method	GET

Example

The Get Order API call requires only one additional piece of data: the Order ID that was generated when the order was placed with the Create Order API. Otherwise, it is a standard GET call as defined with the above table. In this example, the order included these particular properties:

USD
Ship to Home
Order State = Cancelled

After sending the request, the API returns a block of data that covers the details of the order and breaks it down into the following subsections that are described in this guide:

General Information
Shipping Address
Tax
Customer
Order Items

General Information

Besides the three key properties mentioned above, other general order elements include:

Order Type
Delivery Method
Order Currency
Order Date
Order Total

All of this information is clearly specified in the beginning of the response.

"orderID":00000000,
 "orderType":"STANDARD",
 "isTestOrder":true,
 "deliveryMethod":"SHIP_TO_HOME",
 "orderCurrency":"USD",
 "orderDate":"2010-04-08T16:32:03+00:00",
 "orderState":"CANCELED",
 "orderStatus":"CANCELED",
 "customerSubtotal":0,
 "subtotal":4.99,
 "estimatedShipping":0,
 "customerTotal":0,
 "customerTotalNet":0,
 "total":4.99,
 "singlePackageRequested":false,
 "shippingAddress":"1234567",

Shipping Address

Get Order also returns a deep dive into the shipping destination for the entire order.

"shippingAddressInformation": { 
  "addressID":"1234567",
  "customerID":"00000000",
  "firstName":"Test",
  "lastName":"User",
  "addressLine1":"1234 Test Drive",
  "phone":"1112223333",
  "city":"Testville",
  "state":"CA",
  "postalCode":"93405",
  "countryCode":"US",
  "fraudLock":false,  
  "active":true,
  "latitude":35.2783,
  "longitude":-120.682,
  "isBilling":false,
  "isShipping":false 
},

Tax

This brief section breaks down the different types of tax that the order could be subject to.

"tax": {
  "orderTax":0,
  "shippingTax":0,
  "totalTax":0
},

Customer

The response also provides the customer’s other identifying information and contact details.

"customer": {
  "customerID":"0000000",
  "firstName":"Test",
  "lastName":"User",
  "email":"test@kibocommerce.com",
  "password":"*****",
  "phone1":"1112223333",
  "active":"ACTIVE",
  "accountCreated":"2009-01-05T18:18:04+00:00"
},

Order Items

After the data about the overall order, a breakdown of each item follows.

"items":[ 
   { 
      "orderItemID":0000000,
      "itemState":"CANCELED",
      "orderID":0000000,
      "manufacturerID":1234,
      "partNumber":"us-test01",
      "description":"Test 01 - US",
      "quantity":1,
      "subtotal":4.99,
      "retailPrice":4.99,
      "mfgOfferPrice":4.99,
      "lineDiscount":0,
      "shipping":0,
      "actualPrice":4.99,
    ...
   }
],

The Full Request

Using the URL format as outlined above, the entire call is simple to put together. This will return all of the information for the order used in the previous example snippets.

https://{tenantId}-translation.mozu.com/api/v2/order/00000000

The Full Response

This is the full payload returned by the API, which also includes Custom Data elements. These are used to send non-structured data associated with the order items, such as serial numbers, warranty information, customer service information, etc. This example does not have any of this custom data, but the response still indicates where the data would be located if it did.

{  
   "orderID":0000000,
   "orderType":"STANDARD",
   "isTestOrder":true,
   "deliveryMethod":"SHIP_TO_HOME",
   "orderCurrency":"USD",
   "orderDate":"2010-04-08T16:32:03+00:00",
   "orderState":"CANCELED",
   "orderStatus":"CANCELED",
   "customerSubtotal":0,
   "subtotal":4.99,
   "estimatedShipping":0,
   "customerTotal":0,
   "customerTotalNet":0,
   "total":4.99,
   "singlePackageRequested":false,
   "shippingAddress":"1234567",
   "shippingAddressInformation":{  
      "addressID":"1234567",
      "customerID":"0000000",
      "firstName":"Test",
      "lastName":"User",
      "addressLine1":"1234 Test Drive",
      "phone":"1112223333",
      "city":"Testville",
      "state":"CA",
      "postalCode":"93405",
      "countryCode":"US",
      "fraudLock":false,
      "active":true,
      "latitude":35.2783,
      "longitude":-120.692,
      "isBilling":false,
      "isShipping":false
   },
   "fraud":9,
   "fraudLock":"REQUIRES_REVIEW",
   "tax":{  
      "orderTax":0,
      "shippingTax":0,
      "totalTax":0
   },
   "manufacturerID":3456,
   "catalogID":0,
   "customerID":"0000000",
   "customer":{  
      "customerID":"0000000",
      "firstName":"Test",
      "lastName":"User",
      "email":"test@kibocommerce.com",
      "password":"*****",
      "phone1":"1112223333",
      "active":"ACTIVE",
      "accountCreated":"2009-01-05T18:18:04+00:00"
   },
   "items":[  
      {  
         "orderItemID":1111111,
         "itemState":"CANCELED",
         "orderID":0000000,
         "manufacturerID":1234,
         "partNumber":"us-test01",
         "description":"Test 01 - US",
         "quantity":1,
         "subtotal":4.99,
         "retailPrice":4.99,
         "mfgOfferPrice":4.99,
         "lineDiscount":0,
         "shipping":0,
         "actualPrice":4.99,
         "customData":{  

         },
         "capabilities":[  
            "DUPLICATE_ORDER",
            "UNCANCEL_ORDER",
            "UNCANCEL_SHIPMENT",
            "VIEW_TRACKING_INFORMATION",
            "UNCANCEL_ITEM",
            "OFFER_APPEASEMENT",
            "EDIT_CONSUMER_PHONE_NUMBER",
            "ADD_NOTE",
            "VIEW_RESTRICTED_NOTE",
            "ORDER_ROUTING_LOGS",
            "ORDER_SNAPSHOTS"
         ],
         "restrictions":[  
            "CANCEL_ORDER",
            "AUTO_ASSIGN_ORDER",
            "REASSIGN_ORDER",
            "CANCEL_SHIPMENT",
            "AUTO_ASSIGN_SHIPMENT",
            "REASSIGN_SHIPMENT",
            "BACKORDER_SHIPMENT",
            "INCREASE_SHIPPING_AND_HANDLING",
            "DECREASE_SHIPPING_AND_HANDLING",
            "ADD_TRACKING_TO_SHIPMENT",
            "EDIT_TRACKING_NUMBER",
            "DELETE_TRACKING_NUMBER",
            "UNFULFILL_SHIPMENT",
            "AUTO_ASSIGN_ITEM",
            "REASSIGN_ITEM",
            "BACKORDER_ITEM",
            "CANCEL_ITEM",
            "ADD_ITEM",
            "INCREASE_ITEM_QUANTITY",
            "DECREASE_ITEM_QUANTITY",
            "INCREASE_ITEM_PRICE",
            "DECREASE_ITEM_PRICE",
            "INCREASE_ITEM_TAX",
            "DECREASE_ITEM_TAX",
            "RETURN_ITEM",
            "PROCESS_RETURN",
            "ADD_PROMOTION",
            "EDIT_CONSUMER_NAME",
            "EDIT_CONSUMER_EMAIL",
            "EDIT_CONSUMER_SHIPPING_ADDRESS",
            "EDIT_CONSUMER_BILLING_ADDRESS",
            "ADD_PAYMENT_METHOD_CREDIT_CARD",
            "ADD_PAYMENT_METHOD_GIFT_CARD"
         ]
      }
   ],
   "customData":{  

   },
   "orderManagementFee":0,
   "shipType":"REGULAR",
   "ipAddress":"0.1.2.3.",
   "capabilities":[  
      "DUPLICATE_ORDER",
      "UNCANCEL_ORDER",
      "UNCANCEL_SHIPMENT",
      "VIEW_TRACKING_INFORMATION",
      "UNCANCEL_ITEM",
      "OFFER_APPEASEMENT",
      "EDIT_CONSUMER_PHONE_NUMBER",
      "ADD_NOTE",
      "VIEW_RESTRICTED_NOTE",
      "ORDER_ROUTING_LOGS",
      "ORDER_SNAPSHOTS"
   ],
   "restrictions":[  
      "CANCEL_ORDER",
      "AUTO_ASSIGN_ORDER",
      "REASSIGN_ORDER",
      "CANCEL_SHIPMENT",
      "AUTO_ASSIGN_SHIPMENT",
      "REASSIGN_SHIPMENT",
      "BACKORDER_SHIPMENT",
      "INCREASE_SHIPPING_AND_HANDLING",
      "DECREASE_SHIPPING_AND_HANDLING",
      "ADD_TRACKING_TO_SHIPMENT",
      "EDIT_TRACKING_NUMBER",
      "DELETE_TRACKING_NUMBER",
      "UNFULFILL_SHIPMENT",
      "AUTO_ASSIGN_ITEM",
      "REASSIGN_ITEM",
      "BACKORDER_ITEM",
      "CANCEL_ITEM",
      "ADD_ITEM",
      "INCREASE_ITEM_QUANTITY",
      "DECREASE_ITEM_QUANTITY",
      "INCREASE_ITEM_PRICE",
      "DECREASE_ITEM_PRICE",
      "INCREASE_ITEM_TAX",
      "DECREASE_ITEM_TAX",
      "RETURN_ITEM",
      "PROCESS_RETURN",
      "ADD_PROMOTION",
      "EDIT_CONSUMER_NAME",
      "EDIT_CONSUMER_EMAIL",
      "EDIT_CONSUMER_SHIPPING_ADDRESS",
      "EDIT_CONSUMER_BILLING_ADDRESS",
      "ADD_PAYMENT_METHOD_CREDIT_CARD",
      "ADD_PAYMENT_METHOD_GIFT_CARD"
   ],
   "isInventory":false,
   "isGift":false,
   "isExternalPayment":false,
   "orderReferences":{  

   }
}