URI Summary

POST /stores/{storeId}/nodes/{nodeId}/pickTickets/{pickTicketId}

Request Parameters

Parameter Type

Name

Description

Required

Definition

Example

Path

storeId

The store identifier

yes

String

TMSUS

Path

nodeId

The node identifier

yes

String

TMS_NA-Store001

Path

pickTicketId

The unique identifier of the PickTicket for which to retrieve details

yes

String

123223

Request Payload Definition

Element

Required

Description

storeId

yes

The seller organization at which pick ticket belongs.

nodeId

yes

Pick Ticket Ship Node (the physical store)

pickTicketId

yes

The ticket number

Request Payload Example

Copy

{
   "storeId": "TMS_US",
   "nodeId": "TMS_NA-DC001",
   "pickTicketId": "123"
}

Responses

Http Status Code

Description

200

Pick Ticket Details Response

Response Payload Definition

Element

Required

Description

pickTicketDetails{

yes

 

pickTicketId

yes

The ID of this ticket

storeId

yes

The seller organization at which fulfillment order belongs.

nodeId

yes

Fulfillment Order Ship Node

queueId

yes

Queue the order is already on

userId

yes

Login ID of the ROM UI user

status

yes

NEW or IN_PROGRESS or CLOSED

pickTicketType

yes

PICK_TICKET

pickTicketDate

yes

Date/time ticket was created

pickSLADate

yes

Date/time ticket is due

totalFulfillmentOrders

yes

Number of orders on this pick ticket (typically 1 for ISPU)

Currency

yes

USD or EUR

totalSKUs

yes

Number of SKUs on this ticket

totalQuantity

yes

Total number of items to be picked

pickTicketItems[{

yes

 

id

yes

A sequential counter

itemDetails{

yes

 

itemId

yes

The identifier for the item, including catalog

color

yes

Color description

colorCode

yes

Color code

size

yes

Size description

sizeCode

yes

Size code

style

yes

 

quantity

yes

Quantity of this item

unitPrice

yes

Price of this item

retailPrice

yes

Retail store price at this node. Only set > 0 if included in the NodeItem feed.

pickedQuantity

yes

Number picked so far

canceledQuantity

yes

Number canceled so far

cancellationReasoncode

no

Only applies if canceledQuantity > 0

Response Payload Example

Copy

{
    "pickTicketDetails": {
        "pickTicketId": "100011757",
        "storeId": "TMSUS",
        "nodeId": "TMS_NA-Store1",
        "queueId": "WAITING_FOR_PICK_ISPU",
        "userId": "UserId001",
        "status": "CLOSED",
        "pickTicketType": "PICK_TICKET",
        "pickTicketDate": "2021-10-09T15:45:59+00:00",
        "totalFulfillmentOrders": 2,
        "currency": "USD",
        "totalSKUs": 2,
        "totalQuantity": 18,
        "pickTicketItems": [
            {
                "id": "1",
                "itemDetails": {
                    "itemId": "21-ISPUProd02",
                    "color": "Brown",
                    "colorCode": "700",
                    "size": "6-M",
                    "sizeCode": "6-M",
                    "style": "84529"
                },
                "quantity": 5,
                "unitPrice": 114,
                "retailPrice": 0,
                "pickedQuantity": 4,
                "canceledQuantity": 1,
                "cancellationReasonCode": "DEFAULT"
            },
            {
                "id": "2",
                "itemDetails": {
                    "itemId": "21-ISPUProd01",
                    "color": "Brown",
                    "colorCode": "700",
                    "size": "6-M",
                    "sizeCode": "6-M",
                    "style": "84529",
                    "upcs": [
                        {
                            "type": "P",
                            "value": "355470307"
                        }
                    ]
                },
                "quantity": 4,
                "unitPrice": 114,
                "retailPrice": 0,
                "pickedQuantity": 3,
                "canceledQuantity": 1,
                "cancellationReasonCode": "IPD"
            }
        ]
    }
}