Order Ship Confirmation

API accept and process ship confirmation in DOMS

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 {9}]

required

whseId

string

optional

businessUnit

string

optional

buildingId

string

optional

carrier

object

optional

shipDate

string

optional

containers

array [object {6}]

optional

purchaseOrderNumber

string

optional

customerOrderNumber

string

optional

isLastShipmentOrder

string

optional

Possible values N/Y

Example

{
    "data": [
        {
            "whseId": "string",
            "businessUnit": "string",
            "buildingId": "string",
            "carrier": {
                "name": "string",
                "service": "string",
                "proNumber": "string"
            },
            "shipDate": "string",
            "containers": [
                {
                    "dimensions": {
                        "width": 0,
                        "height": 0,
                        "length": 0,
                        "weight": 0,
                        "measurementSystem": "string",
                        "dimWeight": 0
                    },
                    "type": "string",
                    "trackingNumber": "string",
                    "uccLabel": "string",
                    "containerNo": "string",
                    "lines": [
                        {
                            "skuId": "string",
                            "quantity": 0,
                            "cancelledQuantity": 0,
                            "quantityMeasure": "string",
                            "lineNumer": 0,
                            "customerLineNumber": "string",
                            "serialNumbers": [
                                {
                                    "unitSrlNo": "string"
                                }
                            ],
                            "lot": {
                                "lotId": "string",
                                "expiration": "string"
                            },
                            "customerSku": "string"
                        }
                    ]
                }
            ],
            "purchaseOrderNumber": "string",
            "customerOrderNumber": "string",
            "isLastShipmentOrder": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/ups/order/shipconfirm' \
--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",
            "carrier": {
                "name": "string",
                "service": "string",
                "proNumber": "string"
            },
            "shipDate": "string",
            "containers": [
                {
                    "dimensions": {
                        "width": 0,
                        "height": 0,
                        "length": 0,
                        "weight": 0,
                        "measurementSystem": "string",
                        "dimWeight": 0
                    },
                    "type": "string",
                    "trackingNumber": "string",
                    "uccLabel": "string",
                    "containerNo": "string",
                    "lines": [
                        {
                            "skuId": "string",
                            "quantity": 0,
                            "cancelledQuantity": 0,
                            "quantityMeasure": "string",
                            "lineNumer": 0,
                            "customerLineNumber": "string",
                            "serialNumbers": [
                                {
                                    "unitSrlNo": "string"
                                }
                            ],
                            "lot": {
                                "lotId": "string",
                                "expiration": "string"
                            },
                            "customerSku": "string"
                        }
                    ]
                }
            ],
            "purchaseOrderNumber": "string",
            "customerOrderNumber": "string",
            "isLastShipmentOrder": "string"
        }
    ]
}'

Responses

🟢200Ship Confirm 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