Create Pickup

Apply a pickup to the order.

POST /commerce/orders/{orderId}/pickups

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "availableActions": [
    "<string>"
  ],
  "changeMessages": [
    {
      "amount": 123,
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "attributes": {},
      "correlationId": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "identifier": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "newValue": "<string>",
      "oldValue": "<string>",
      "subject": "<string>",
      "subjectType": "<string>",
      "success": true,
      "userFirstName": "<string>",
      "userId": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "verb": "<string>"
    }
  ],
  "code": "<string>",
  "fulfillmentDate": "2023-11-07T05:31:56Z",
  "fulfillmentLocationCode": "<string>",
  "id": "<string>",
  "items": [
    {
      "fulfillmentItemType": "<string>",
      "lineId": 123,
      "optionAttributeFQN": "<string>",
      "productCode": "<string>",
      "quantity": 123
    }
  ],
  "status": "<string>"
}

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.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

Pickup to create and add to the order

Represents a pickup by a customer from a merchant.

auditInfo · object

Show child attributes

availableActions · string[] | null

Actions that can be taken on this fulfillment unit

changeMessages · object[] | null

Change messages related to the fulfillment unit.

Show child attributes

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}

fulfillmentDate · string<date-time> | null

Date of the pickup

fulfillmentLocationCode · string | null

Location code from which to obtain this item

id · string | null

ID of the fulfillment unit.

items · object[] | null

List of items in the fulfillment unit

Show child attributes

status · string | null

Status of the fulfillment unit See FulfillmentStatusConst

Response

200

application/json

Success

Represents a pickup by a customer from a merchant.

auditInfo · object

Show child attributes

availableActions · string[] | null

Actions that can be taken on this fulfillment unit

changeMessages · object[] | null

Change messages related to the fulfillment unit.

Show child attributes

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}

fulfillmentDate · string<date-time> | null

Date of the pickup

fulfillmentLocationCode · string | null

Location code from which to obtain this item

id · string | null

ID of the fulfillment unit.

items · object[] | null

List of items in the fulfillment unit

Show child attributes

status · string | null

Status of the fulfillment unit See FulfillmentStatusConst