Skip to main content
GET
/
commerce
/
orders
/
{orderId}
/
pickups
/
{pickupId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "code": "<string>",
  "status": "<string>",
  "items": [
    {
      "productCode": "<string>",
      "quantity": 123,
      "fulfillmentItemType": "<string>",
      "lineId": 123,
      "optionAttributeFQN": "<string>"
    }
  ],
  "fulfillmentDate": "2023-11-07T05:31:56Z",
  "fulfillmentLocationCode": "<string>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "availableActions": [
    "<string>"
  ],
  "changeMessages": [
    {
      "id": "<string>",
      "correlationId": "<string>",
      "userId": "<string>",
      "userFirstName": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "subjectType": "<string>",
      "success": true,
      "identifier": "<string>",
      "subject": "<string>",
      "verb": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "oldValue": "<string>",
      "newValue": "<string>",
      "amount": 123,
      "createDate": "2023-11-07T05:31:56Z",
      "attributes": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
orderId
string
required

Unique identifier of the order with which to associate the pickup.

​
pickupId
string
required

Pickup to remove from the order

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Represents a pickup by a customer from a merchant.

​
id
string | null

ID of the fulfillment unit.

​
code
string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form {fulfillmentUnitType} #{next available int}

​
status
string | null

Status of the fulfillment unit See FulfillmentStatusConst

​
items
object[] | null

List of items in the fulfillment unit

​
fulfillmentDate
string<date-time> | null

Date of the pickup

​
fulfillmentLocationCode
string | null

Location code from which to obtain this item

​
auditInfo
object
​
availableActions
string[] | null

Actions that can be taken on this fulfillment unit

​
changeMessages
object[] | null

Change messages related to the fulfillment unit.