Order Status Updates - UPS-DOMS-WMS

Accept and Process order status updates.

Request

Header Params

Token

string

required

Bearer Token

Example:

Bearer eyJ0eXBlIjoiU0lHTkVELUpXVCIsIndoc2VfaWQiOiJVUFMiLCJibGRnX2lkIjoiQ0FGQU4iLCJjb21wYW55X25vIjoiRFlTT04iLCJhbGxvd2VkX3BhdGgiOiIiLCJhbGciOiJSUzUxMiJ9.eyJpc3MiOiJzb2Z0ZW9uLmNvbSIsInN1YiI6InNvZnRlb24vYXV0aC9qd3QiLCJleHAiOjE3MTUwNjU0MzMsIm5hbWUiOiJzb2Z0ZW9uIiwic2NvcGUiOiJBUEkifQ.bDyEdwNFuqrT05v7A2_uwRqQ9-S2wJF-1IwWYZYDed5M5ee5VScLD8i2WXjF9cfzNjyARfdVzD-ZZRmH8eycPCzKZowWJ-D-RuTxmxBH2ubizZ5V2uexpNR2nzfAt4L43wGEV-S4-eAlf3LTQdoTgjMYgdRWApm0m_8GpKvG88_idUCpSPui5mD5yjxsWOoSo6rDXqfuGl21K1G5WoV90ULm7sOXj2gKI7feJk7jbQi-whRkIwfNaEm-2iM1x-oQc8u23jyfYp-qidMb5k4ae3jwlA36a7s3d-SKZ56tNsBgQLzJ6rxx5lVC5FwJS5aE1eQSMdoHWLnuMvJIiYB_GQ

WhseId

string

required

Warehouse Id of Client DOMS

Example:

UPS

BusinessUnit

string

required

Business Unit Code of the Client in DOMS

Example:

POCSPORTS

BldgId

string

required

Building Id of the Client in DOMS

Example:

NVRN1

Body Params application/json

data

array [object {7}]

required

whseId

string

required

businessUnit

string

required

buildingId

string

required

customerOrderNumber

string

required

status

string

required

Example:

Status Status - DOMS Cd WH_DROPPED - 200 WH_PROCESSING - 210 WAVED - 260 IN_PICKING - 265 PICKING_COMPLETE - 270 ORDER_PACKED - 275 LOADED - 280 PARTIALLY_SHIPPED - 300 SHIP_COMPLETE - 400 CANCELLED - 000

errorMessage

string

optional

cancelReasonCode

string

optional

Example:

cancelReasonCode BC - Back Order Cancel ER - Energy Rating Hold Cancel SC - SORTEDPRO Cancel 805 - PENDING CANCEL IN DOMS 810 - PENDING CANCEL IN DC 900 - Vendor Sourced 955 - DC SPLIT CANCEL (LOAD) 957 - B/O SPLIT CANCEL IN DOMS 961 - DC SPLIT CANCEL 962 - B/O SPLIT CANCEL IN DC 967 - 999 SPLIT 969 - TRUCK LOAD SPLIT 980 - No Inventory 982 - BO CANCEL KILL IN DC 983 - OLD BACKORDER CANCEL 985 - DC CHANGE CANCEL 986 - BAD CREDIT CANCEL 990 - SKU SUBSTITUTION PENDING CANCEL 991 - CANCELLATION FROM PENDING CANCEL 992 - CANCEL BASED ON UPDATE RERQUEST 995 - CANCELLATION FOR ORDER CONSOLIDATION 998 - MANUAL ORDER CANCEL 999 - WEB ORDER CANCEL

Example

{
    "data": [
        {
            "whseId": "string",
            "businessUnit": "string",
            "buildingId": "string",
            "customerOrderNumber": "string",
            "status": "Status Status - DOMS Cd  WH_DROPPED - 200  WH_PROCESSING - 210  WAVED - 260  IN_PICKING - 265  PICKING_COMPLETE - 270  ORDER_PACKED - 275  LOADED - 280  PARTIALLY_SHIPPED - 300  SHIP_COMPLETE - 400  CANCELLED - 000",
            "errorMessage": "string",
            "cancelReasonCode": "cancelReasonCode  BC - Back Order Cancel ER - Energy Rating Hold Cancel SC - SORTEDPRO Cancel 805 - PENDING CANCEL IN DOMS 810 - PENDING CANCEL IN DC 900 - Vendor Sourced 955 - DC SPLIT CANCEL (LOAD) 957 - B/O SPLIT CANCEL IN DOMS 961 - DC SPLIT CANCEL 962 - B/O SPLIT CANCEL IN DC 967 - 999 SPLIT 969 - TRUCK LOAD SPLIT 980 - No Inventory 982 - BO CANCEL KILL IN DC 983 - OLD BACKORDER CANCEL 985 - DC CHANGE CANCEL 986 - BAD CREDIT CANCEL 990 - SKU SUBSTITUTION PENDING CANCEL 991 - CANCELLATION FROM PENDING CANCEL 992 - CANCEL BASED ON UPDATE RERQUEST 995 - CANCELLATION FOR ORDER CONSOLIDATION 998 - MANUAL ORDER CANCEL 999 - WEB ORDER CANCEL"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/ups/order/orderupdate' \
--header 'Token: Bearer eyJ0eXBlIjoiU0lHTkVELUpXVCIsIndoc2VfaWQiOiJVUFMiLCJibGRnX2lkIjoiQ0FGQU4iLCJjb21wYW55X25vIjoiRFlTT04iLCJhbGxvd2VkX3BhdGgiOiIiLCJhbGciOiJSUzUxMiJ9.eyJpc3MiOiJzb2Z0ZW9uLmNvbSIsInN1YiI6InNvZnRlb24vYXV0aC9qd3QiLCJleHAiOjE3MTUwNjU0MzMsIm5hbWUiOiJzb2Z0ZW9uIiwic2NvcGUiOiJBUEkifQ.bDyEdwNFuqrT05v7A2_uwRqQ9-S2wJF-1IwWYZYDed5M5ee5VScLD8i2WXjF9cfzNjyARfdVzD-ZZRmH8eycPCzKZowWJ-D-RuTxmxBH2ubizZ5V2uexpNR2nzfAt4L43wGEV-S4-eAlf3LTQdoTgjMYgdRWApm0m_8GpKvG88_idUCpSPui5mD5yjxsWOoSo6rDXqfuGl21K1G5WoV90ULm7sOXj2gKI7feJk7jbQi-whRkIwfNaEm-2iM1x-oQc8u23jyfYp-qidMb5k4ae3jwlA36a7s3d-SKZ56tNsBgQLzJ6rxx5lVC5FwJS5aE1eQSMdoHWLnuMvJIiYB_GQ' \
--header 'WhseId: UPS' \
--header 'BusinessUnit: POCSPORTS' \
--header 'BldgId: NVRN1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "whseId": "string",
            "businessUnit": "string",
            "buildingId": "string",
            "customerOrderNumber": "string",
            "status": "Status Status - DOMS Cd  WH_DROPPED - 200  WH_PROCESSING - 210  WAVED - 260  IN_PICKING - 265  PICKING_COMPLETE - 270  ORDER_PACKED - 275  LOADED - 280  PARTIALLY_SHIPPED - 300  SHIP_COMPLETE - 400  CANCELLED - 000",
            "errorMessage": "string",
            "cancelReasonCode": "cancelReasonCode  BC - Back Order Cancel ER - Energy Rating Hold Cancel SC - SORTEDPRO Cancel 805 - PENDING CANCEL IN DOMS 810 - PENDING CANCEL IN DC 900 - Vendor Sourced 955 - DC SPLIT CANCEL (LOAD) 957 - B/O SPLIT CANCEL IN DOMS 961 - DC SPLIT CANCEL 962 - B/O SPLIT CANCEL IN DC 967 - 999 SPLIT 969 - TRUCK LOAD SPLIT 980 - No Inventory 982 - BO CANCEL KILL IN DC 983 - OLD BACKORDER CANCEL 985 - DC CHANGE CANCEL 986 - BAD CREDIT CANCEL 990 - SKU SUBSTITUTION PENDING CANCEL 991 - CANCELLATION FROM PENDING CANCEL 992 - CANCEL BASED ON UPDATE RERQUEST 995 - CANCELLATION FOR ORDER CONSOLIDATION 998 - MANUAL ORDER CANCEL 999 - WEB ORDER CANCEL"
        }
    ]
}'

Responses

🟢200Order status Created

application/json

Body

transId

string

optional

transType

string

optional

referenceDetail

array [object {3}]

optional

referenceId

string

optional

externalRefernceId

string

optional

status

string

optional

Example

{
    "transId": "string",
    "transType": "string",
    "referenceDetail": [
        {
            "referenceId": "string",
            "externalRefernceId": "string",
            "status": "string"
        }
    ]
}

🟠400Bad Request

🟠401Authentication Failed

🔴500Internal Server Error