Check-In Confirm

This endpoint supports the Ship-to Store fulfillment type.

URI Summary

POST /stores/{storeId}/nodes/{nodeId}/fulfillmentOrders/{fulfillmentOrderId}/checkin

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	fulfillmentOrderId	Unique number associated with Fulfillment Order	yes	String	100051718744001

Request Payload Definition

Element	Required	Description
modifyAssociatedId	yes	The associate handling the pickup confirm
fulfillmentOrder{	yes	Parent for all remaining rows
action	yes	CONFIRM
storeId	yes	The seller organization at which fulfillment order belongs.
nodeId	yes	Fulfillment Order Ship Node
fulfillmentOrderId	yes	Unique number associated with Fulfillment Order
holdLocation	yes	Where the package is going to be put. This will vary by client and possibly by node.
checkInPackages[{	yes	Packages for this fulfillment order
checkInPackageId	yes	Internal identifier for this package. Comes from the Detail call payload, based on the tracking number
checkInPackageItems[{	yes	The items in this package
itemId	yes	Full item ID with catalog number
webLineId	yes	Line number on the original web order
quantity	yes	How many are supposed to be in the package?
checkInQuantity	yes	How many were actually in the package?
checkInCanceledQuantity	yes	How many were missing or damaged?
checkInCancellationReasonCode	no	Required if the canceled quantity is > 0

Request Payload Example

Copy this code sample.

{
  "modifyAssociateId": "associate_id",
  "fulfillmentOrder": {
    "action" : "UPDATE/CONFIRM",
    "storeId": "TMSUS",
    "nodeId": "TMS_NA-Store1",
    "fulfillmentOrderId": "100051718744001",
    "holdLocation": "Loc1-123",
    "checkInPackages": [
      {
      "checkInPackageId": "100131671",
      "checkInPackageItems": [{
        "itemId": "21-ISPUProd01",
        "webLineId": "1",
        "quantity": 1,
        "checkInQuantity": 2,
        "checkInCanceledQuantity": 1,
        "checkInCancellationReasonCode": "IDD"
      },
        {
          "itemId": "21-ISPUProd02",
          "webLineId": "2",
          "quantity": 1,
          "checkInQuantity": 2,
          "checkInCanceledQuantity": 1,
          "checkInCancellationReasonCode": "IDD"
        }
      ]
    },
      {
        "checkInPackageId": "100131691",
        "checkInPackageItems": [{
          "itemId": "21-ISPUProd03",
          "webLineId": "3",
          "quantity": 1,
          "checkInQuantity": 2,
          "checkInCanceledQuantity": 1,
          "checkInCancellationReasonCode": "IDD"
        },
          {
            "itemId": "21-ISPUProd04",
            "webLineId": "4",
            "quantity": 1,
            "checkInQuantity": 2,
            "checkInCanceledQuantity": 1,
            "checkInCancellationReasonCode": "IDD"
          }
        ]
      }
    ]
  }
}

Responses

Http Status Code	Description
204	Success, no content
400	Bad Request
500	Internal Server Error