Get Shipment 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 Shipment API retrieves information about a shipment.

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/shipment/{shipmentID}
Sandbox URL	https://{tenantId}-translation.sandbox.mozu.com/api/v2/shipment/{shipmentID}
Supported Formats	JSON
HTTP Method	GET

Example

The Get Shipment API call requires only one additional piece of data: the Shipment ID. Otherwise, it is a standard GET call as defined with the above table. In this example, the shipment included these particular properties:

Ship to Home shipment with ID 00000000
Regular Ship Type that was shipped from a Distribution Center

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

General Information
Shipping Address
Shipment Items

General Information

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

Associated IDs
Shipment Status

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

    "shipmentID":00000000,
    "orderID":1234567,
    "manufacturerID":11111,
    "externalOrderID":"0123456789",
    "catalogID":1,
    "shipmentStatus":"READY",
    "shipmentStateCode":"1-100",
    "shipmentStateName":"accept_order",
    "shipmentStateType":"STH",
    "shipType":"REGULAR",
    "packingListLink":"https://www.shopatron.com/...",
    "assignedLocation":00000,
    "shipperName":"DISTRIBUTION CENTER",
    "shippingAddress":"7654321",

Shipping Address

The response provides all of the necessary information about where to send this shipment.

"shippingAddressInformation":{
        "addressID":"20595714",
        "customerID":"1010101",
        "firstName":"Test",
        "lastName":"User",
        "addressLine1":"111 Test St",
        "phone":"000-000-0000",
        "city":"Testville",
        "state":"CA",
        "postalCode":"000000",
        "countryCode":"US",
        "fraudLock":false,
        "active":true,
        "latitude":00.0000,
        "longitude":-00.000,
        "isBilling":false,
        "isShipping":false
    },

Shipment Items

The response also contains a list of all items included in the shipment. These may not be all of the items for the associated order, because if an order is split into multiple packages then each package has its own Shipment ID. Only the items that are part of this Shipment ID’s package are listed by the API.

"items":[
        {
            "orderItemID":1212121,
            "itemState":"NORMAL",
            "orderID":123456,
            "shipmentID":0000000,
            "manufacturerID":00000,
            "partNumber":"111-22222-33-S",
            "upc":"01010101010101",
            "description":"Pants",
            "quantity":1,
            "subtotal":17.48,
            "subtotalTaxAmount":1.17,
            "subtotalGross":18.65,
            "retailPrice":24.97,
            "mfgOfferPrice":17.48,
            "lineDiscount":0,
            "shipping":3,
            "actualPrice":17.48,
            "actualPriceTaxAmount":1.17,
            "taxRate":0.06693,
            "customData":{

            },
            "options":[
                "color: Grey",
                "size: S"
            ],
            "serialNumberRequired":true,
            "capabilities":[
                "DUPLICATE_ORDER",
                "CANCEL_SHIPMENT",
                "AUTO_ASSIGN_SHIPMENT",
                "REASSIGN_SHIPMENT",
                "BACKORDER_SHIPMENT",
                "INCREASE_SHIPPING_AND_HANDLING",
                "DECREASE_SHIPPING_AND_HANDLING",
                "VIEW_TRACKING_INFORMATION",
                "ADD_TRACKING_TO_SHIPMENT",
                "EDIT_TRACKING_NUMBER",
                "DELETE_TRACKING_NUMBER",
                "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",
                "OFFER_APPEASEMENT",
                "ADD_PROMOTION",
                "EDIT_CONSUMER_NAME",
                "EDIT_CONSUMER_EMAIL",
                "EDIT_CONSUMER_PHONE_NUMBER",
                "EDIT_CONSUMER_SHIPPING_ADDRESS",
                "EDIT_CONSUMER_BILLING_ADDRESS",
                "ADD_PAYMENT_METHOD_CREDIT_CARD",
                "ADD_PAYMENT_METHOD_GIFT_CARD",
                "ADD_NOTE",
                "VIEW_RESTRICTED_NOTE",
                "ORDER_ROUTING_LOGS",
                "ORDER_SNAPSHOTS"
            ],
            "restrictions":[
                "CANCEL_ORDER",
                "UNCANCEL_ORDER",
                "AUTO_ASSIGN_ORDER",
                "REASSIGN_ORDER",
                "UNCANCEL_SHIPMENT",
                "UNFULFILL_SHIPMENT",
                "UNCANCEL_ITEM",
                "RETURN_ITEM",
                "PROCESS_RETURN"
            ],
            "discounts":[
            ]
        }
    ],

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 shipment with the above example ID.

https://{tenantId}-translation.mozu.com/api/v2/shipment/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.

{
    "shipmentID":00000000,
    "orderID":1234567,
    "manufacturerID":11111,
    "externalOrderID":"0123456789",
    "catalogID":1,
    "shipmentStatus":"READY",
    "shipmentStateCode":"1-100",
    "shipmentStateName":"accept_order",
    "shipmentStateType":"STH",
    "shipType":"REGULAR",
    "packingListLink":"https://www.shopatron.com/...",
    "assignedLocation":00000,
    "shipperName":"DISTRIBUTION CENTER",
    "shippingAddress":"7654321",
    "shippingAddressInformation":{
        "addressID":"20595714",
        "customerID":"1010101",
        "firstName":"Test",
        "lastName":"User",
        "addressLine1":"111 Test St",
        "phone":"000-000-0000",
        "city":"Testville",
        "state":"CA",
        "postalCode":"000000",
        "countryCode":"US",
        "fraudLock":false,
        "active":true,
        "latitude":00.0000,
        "longitude":-00.000,
        "isBilling":false,
        "isShipping":false
    },
    "items":[
        {
            "orderItemID":1212121,
            "itemState":"NORMAL",
            "orderID":123456,
            "shipmentID":0000000,
            "manufacturerID":00000,
            "partNumber":"111-22222-33-S",
            "upc":"01010101010101",
            "description":"Pants",
            "quantity":1,
            "subtotal":17.48,
            "subtotalTaxAmount":1.17,
            "subtotalGross":18.65,
            "retailPrice":24.97,
            "mfgOfferPrice":17.48,
            "lineDiscount":0,
            "shipping":3,
            "actualPrice":17.48,
            "actualPriceTaxAmount":1.17,
            "taxRate":0.06693,
            "customData":{

            },
            "options":[
                "color: Grey",
                "size: S"
            ],
            "serialNumberRequired":true,
            "capabilities":[
                "DUPLICATE_ORDER",
                "CANCEL_SHIPMENT",
                "AUTO_ASSIGN_SHIPMENT",
                "REASSIGN_SHIPMENT",
                "BACKORDER_SHIPMENT",
                "INCREASE_SHIPPING_AND_HANDLING",
                "DECREASE_SHIPPING_AND_HANDLING",
                "VIEW_TRACKING_INFORMATION",
                "ADD_TRACKING_TO_SHIPMENT",
                "EDIT_TRACKING_NUMBER",
                "DELETE_TRACKING_NUMBER",
                "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",
                "OFFER_APPEASEMENT",
                "ADD_PROMOTION",
                "EDIT_CONSUMER_NAME",
                "EDIT_CONSUMER_EMAIL",
                "EDIT_CONSUMER_PHONE_NUMBER",
                "EDIT_CONSUMER_SHIPPING_ADDRESS",
                "EDIT_CONSUMER_BILLING_ADDRESS",
                "ADD_PAYMENT_METHOD_CREDIT_CARD",
                "ADD_PAYMENT_METHOD_GIFT_CARD",
                "ADD_NOTE",
                "VIEW_RESTRICTED_NOTE",
                "ORDER_ROUTING_LOGS",
                "ORDER_SNAPSHOTS"
            ],
            "restrictions":[
                "CANCEL_ORDER",
                "UNCANCEL_ORDER",
                "AUTO_ASSIGN_ORDER",
                "REASSIGN_ORDER",
                "UNCANCEL_SHIPMENT",
                "UNFULFILL_SHIPMENT",
                "UNCANCEL_ITEM",
                "RETURN_ITEM",
                "PROCESS_RETURN"
            ],
            "discounts":[

            ]
        }
    ],
    "orderType":"STANDARD",
    "createDate":"2017-09-08T17:09:07+00:00",
    "orderDate":"2017-09-08T17:09:03+00:00",
    "subtotal":17.48,
    "total":21.65,
    "shippingFee":3,
    "shippingTax":0,
    "shippingTaxRate":0,
    "shipmentItemTax":1.17,
    "shopatronTotal":3.35,
    "packageFee":1.29,
    "fulfillerTotal":18.3,
    "fulfillerShipping":2.81,
    "fulfillerTax":1.09,
    "readyDate":"2017-09-08T17:09:07+00:00",
    "isLate":false,
    "capabilities":[
        "DUPLICATE_ORDER",
        "CANCEL_SHIPMENT",
        "AUTO_ASSIGN_SHIPMENT",
        "REASSIGN_SHIPMENT",
        "BACKORDER_SHIPMENT",
        "INCREASE_SHIPPING_AND_HANDLING",
        "DECREASE_SHIPPING_AND_HANDLING",
        "VIEW_TRACKING_INFORMATION",
        "ADD_TRACKING_TO_SHIPMENT",
        "EDIT_TRACKING_NUMBER",
        "DELETE_TRACKING_NUMBER",
        "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",
        "OFFER_APPEASEMENT",
        "ADD_PROMOTION",
        "EDIT_CONSUMER_NAME",
        "EDIT_CONSUMER_EMAIL",
        "EDIT_CONSUMER_PHONE_NUMBER",
        "EDIT_CONSUMER_SHIPPING_ADDRESS",
        "EDIT_CONSUMER_BILLING_ADDRESS",
        "ADD_PAYMENT_METHOD_CREDIT_CARD",
        "ADD_PAYMENT_METHOD_GIFT_CARD",
        "ADD_NOTE",
        "VIEW_RESTRICTED_NOTE",
        "ORDER_ROUTING_LOGS",
        "ORDER_SNAPSHOTS"
    ],
    "restrictions":[
        "CANCEL_ORDER",
        "UNCANCEL_ORDER",
        "AUTO_ASSIGN_ORDER",
        "REASSIGN_ORDER",
        "UNCANCEL_SHIPMENT",
        "UNFULFILL_SHIPMENT",
        "UNCANCEL_ITEM",
        "RETURN_ITEM",
        "PROCESS_RETURN"
    ],
    "isGift":false,
    "isTestOrder":false
}