Get Pick Wave

Retrieve pick wave details by its ID number.

GET /commerce/pickwaves/{pickWaveNumber}

Error

A valid request URL is required to generate request examples

200

{
  "_links": {
    "empty": true
  },
  "attributes": {},
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "changeMessages": [
    {
      "amount": 123,
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "appeasementReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "attributes": {},
      "changeMessageId": "<string>",
      "correlationId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "identifier": "<string>",
      "message": "<string>",
      "metadata": "<string>",
      "newValue": "<string>",
      "oldValue": "<string>",
      "subject": "<string>",
      "subjectType": "<string>",
      "success": true,
      "userDisplayName": "<string>",
      "userFirstName": "<string>",
      "userId": "<string>",
      "userLastName": "<string>",
      "verb": "<string>"
    }
  ],
  "contents": [
    {
      "actualQuantity": 123,
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "binId": 123,
      "binName": "<string>",
      "contentId": "<string>",
      "externalOrderId": "<string>",
      "imageUrl": "<string>",
      "itemLineId": 123,
      "locatorName": "<string>",
      "name": "<string>",
      "optionAttributeFQN": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "attributes": {},
          "dataType": "<string>",
          "name": "<string>",
          "shopperEnteredValue": {},
          "stringValue": "<string>",
          "value": {}
        }
      ],
      "orderNumber": 123,
      "partNumber": "<string>",
      "productCode": "<string>",
      "quantity": 123,
      "shipmentNumber": 123,
      "sku": "<string>",
      "upc": "<string>",
      "variationProductCode": "<string>"
    }
  ],
  "fulfillmentLocationCode": "<string>",
  "maxShipments": 123,
  "parentPickWaveNumber": 123,
  "pickWaveId": "<string>",
  "pickWaveNumber": 123,
  "recoveryPickWaveNumber": 123,
  "shipmentNumbers": [
    123
  ],
  "shipmentType": "<string>",
  "tenantId": 123,
  "userDisplayName": "<string>",
  "userId": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

pickWaveNumber · integer<int32> · required

pickWaveNumber

Query Parameters

sortContents · string

Response

200

application/hal+json

OK

_links · Links · object

Show child attributes

attributes · object

Show child attributes

auditInfo · AuditInfo0 · object

Show child attributes

changeMessages · ChangeMessage · object[]

Show child attributes

contents · PickWaveContent · object[]

Show child attributes

fulfillmentLocationCode · string

maxShipments · integer<int32>

parentPickWaveNumber · integer<int32>

pickType · enum<string>

Available options: NORMAL, SINGLE, MULTIPLE

pickWaveId · string

pickWaveNumber · integer<int32>

pickWaveStatus · enum<string>

Available options: ERROR, PENDING, IN_PROGRESS, CLOSED, PENDING_RECOVERY

recoveryPickWaveNumber · integer<int32>

shipmentNumbers · integer<int32>[]

shipmentType · string

tenantId · integer<int32>

userDisplayName · string

userId · string