For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
Storefront
Types
Objects
OrderPickupConsignment
OBJECT
Copy page
A pickup consignment for an order.
Fields
entityId
Integer
Required
Consignment ID.
pickupMethodName
String
Required
Pickup method display name.
collectionInstructions
String
Required
Collection instructions.
collectionTimeDescription
String
Required
Collection time description.
locationName
String
Required
Location name.
address
OrderPickupLocationAddress
Required
Pickup address.
Show 9 fields
lineItems
OrderPhysicalLineItemConnection
Required
Physical line items for the consignment.
Show arguments and fields
Referenced by
Fields
OrderPickupConsignmentEdge.node
