Get Pickup

get https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/orders/{orderId}/pickups/{pickupId}

Gets a specified pickup on the order.

Response

Response body

object

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

array of objects | null

List of items in the fulfillment unit

items

object

productCode

string | null

Code of the Product to be fulfilled.

quantity

int32

Quantity of the order item

fulfillmentItemType

string | null

The type of fulfillment item

lineId

int32 | null

The line id associated with the fulfillment.

optionAttributeFQN

string | null

fulfillmentDate

date-time | null

Date of the pickup

fulfillmentLocationCode

string | null

Location code from which to obtain this item

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

availableActions

array of strings | null

Actions that can be taken on this fulfillment unit

availableActions

changeMessages

array of objects | null

Change messages related to the fulfillment unit.

changeMessages

object

string | null

Unique identifier of the message. System-supplied. Read-only.

correlationId

string | null

Correlation Id

userId

string | null

User Id that identifies the user that performed the related change

userFirstName

string | null

User First Name

userLastName

string | null

User Last Name

userScopeType

string | null

User Type (e.g. Shopper, Admin, etc.)

appId

string | null

App Id that identifies the user that performed the related change

appKey

string | null

App Key

appName

string | null

App Name

subjectType

string | null

Subject of the message, for example, "Product." System-supplied. Read-only.

success

boolean | null

Indicates if the message is related to a success or failure.

identifier

string | null

Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.

subject

string | null

Text on the subject line of the message, for example, the product name. System-supplied. Read-only.

verb

string | null

Action applicable to the message. This can be "Increased," when the product price has increased, "Decreased," when the
product price has decreased, and "Invalidated," when the product is no longer available. System-supplied. Read-only.

message

string | null

Human readable message. System-supplied. Read-only.

metadata

string

Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only.

oldValue

string | null

deprecated

Original price of the item. System-supplied. Read-only.

newValue

string | null

deprecated

Current price of the item. System-supplied. Read-only.

amount

double | null

deprecated

Monetary amount that pertains to the change if applicable

createDate

date-time | null

When the message was created. System-supplied. Read-only.

attributes

object | null

Additional Data. This property will be a Dictionary of objects.

Has additional fields

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/orders/orderId/pickups/pickupId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success