Order Pickup Reminder Event
For in-store pickup orders, the Order Pickup Reminder event is sent when a customer has not picked up an item from the store after a predetermined time period.
Radial supports two different ways to receive event messages from this API and other event-based APIs.
-
If you use the queue-based implementation with AMQP, each event is sent in its own OrderPickupReminder message.
-
If you use the webhooks-based implementation, a set of events is grouped together in an OrderPickupReminderList message.
Schemas:
- Order-Pickup-Reminder-Event-1.0.xsd
- Checkout-Datatypes-1.0.xsd
- Order-Common-Event-1.0.xsd
- Order-Datatypes-Common-1.0.xsd
- Payment-Datatypes-1.0.xsd
- Payment-Datatypes-CurrencyCode-1.0.xsd
Order Pickup Reminder Event Types:
- Pickup reminder message
- Pickup reminder proxy message
XPath: /OrderPickupReminder/OrderItem/
Proxy event will have extra ProxyInformation. For example:
<ProxyInformation>
<ProxyName>Proxy Pickup Person Name</ProxyName>
<ProxyFirstName/>
<ProxyLastName/>
<ProxyEmail>proxypersonemail@domain.com</ProxyEmail>
<ProxyPhone/>
<Relationship/>
</ProxyInformation>
OrderPickupReminder Messages
For queue-based implementations, a new OrderPickupReminder message is generated for each new event.
Queue name: q.Order.Pickup.Reminder.<StoreCode>.2-0
Single-Event Message Examples
Click any heading below to view the contents of the sample message file.
<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReminder xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="00081o526231114"
storeId="StoreCode"
locale="en_US"
orderDate="2021-01-28T03:05:12+00:00"
currencySymbol="$"
currency="USD">
<Customer>
<Name>
<LastName>last name</LastName>
<FirstName>last name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>last name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60623</PostalCode>
</Address>
<PhoneNumber/>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<OrderItems>
<OrderItem webLineId="1" itemId="67-1599381">
<Description>
<Description>Fila Memory Faction</Description>
<SKU>43338871</SKU>
<UPC/>
<GlobalId/>
<Title>Fila Memory Faction</Title>
<Color id="174908">Grey/Coral</Color>
<Size id="50397">7W</Size>
<StyleNumber/>
</Description>
<Pricing>
<Amount>42.48</Amount>
<UnitPrice>39.98</UnitPrice>
</Pricing>
<FulfillmentMethod>STORE_PICK_UP</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<ReleaseStatuses>
<ReleaseStatus statusCode="3700.00.2000" statusDescription="Pickup Complete" quantity="1"
totalQuantity="1"/>
</ReleaseStatuses>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20210203</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderItems>
<Destination>
<StoreFrontDetail>
<StoreCode>568</StoreCode>
<StoreName>TEST STORE</StoreName>
<StoreEmail/>
<Address>
<Line1>123 ROAD</Line1>
<Line2>SUITE A</Line2>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60632</PostalCode>
</Address>
<StoreDirections/>
<StoreHours>09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|11:00 AM - 07:00 PM</StoreHours>
<StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
</StoreFrontDetail>
</Destination>
</OrderPickupReminder>
<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReminder xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="00081o52811113"
storeId="StoreCode"
locale="en_US"
orderDate="2021-02-06T13:17:51+00:00"
currencySymbol="$"
currency="USD">
<Customer>
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Stockbridge</City>
<MainDivision>GA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>30281</PostalCode>
</Address>
<PhoneNumber/>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<OrderItems>
<OrderItem webLineId="1" itemId="67-1163367">
<Description>
<Description>Crocs Mercy Work Slip Resistant</Description>
<SKU>41401786</SKU>
<UPC/>
<GlobalId/>
<Title>Crocs Mercy Work Slip Resistant</Title>
<Color id="28235">Black/Silver</Color>
<Size id="50435">8M</Size>
<StyleNumber/>
</Description>
<Pricing>
<Amount>33.90</Amount>
<UnitPrice>39.98</UnitPrice>
</Pricing>
<FulfillmentMethod>STORE_PICK_UP</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<ReleaseStatuses>
<ReleaseStatus statusCode="3700.00.1000" statusDescription="Ready For Pickup" quantity="1"
totalQuantity="1"/>
</ReleaseStatuses>
<ProxyInformation>
<ProxyName>Proxy Pickup Person Name</ProxyName>
<ProxyFirstName/>
<ProxyLastName/>
<ProxyEmail>proxypersonemail@domain.com</ProxyEmail>
<ProxyPhone/>
<Relationship/>
</ProxyInformation>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20210213</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderItems>
<Destination>
<StoreFrontDetail>
<StoreCode>519</StoreCode>
<StoreName>TEST STORE</StoreName>
<StoreEmail/>
<Address>
<Line1>123 BLVD</Line1>
<Line2>STE C</Line2>
<City>Smyrna</City>
<MainDivision>GA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>30080</PostalCode>
</Address>
<StoreDirections/>
<StoreHours>10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|11:00 AM - 07:00 PM</StoreHours>
<StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
</StoreFrontDetail>
</Destination>
</OrderPickupReminder>
OrderPickupReminderList Messages
For Webhooks-based events, Order Pickup Reminder events are grouped together in one OrderPickupReminderList message.
Event List Message Examples
Click any heading below to view the contents of the sample message file.
<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReminder xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="00081o526231114"
storeId="StoreCode"
locale="en_US"
orderDate="2021-01-28T03:05:12+00:00"
currencySymbol="$"
currency="USD">
<Customer>
<Name>
<LastName>last name</LastName>
<FirstName>last name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>last name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60623</PostalCode>
</Address>
<PhoneNumber/>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<OrderItems>
<OrderItem webLineId="1" itemId="67-1599381">
<Description>
<Description>Fila Memory Faction</Description>
<SKU>43338871</SKU>
<UPC/>
<GlobalId/>
<Title>Fila Memory Faction</Title>
<Color id="174908">Grey/Coral</Color>
<Size id="50397">7W</Size>
<StyleNumber/>
</Description>
<Pricing>
<Amount>42.48</Amount>
<UnitPrice>39.98</UnitPrice>
</Pricing>
<FulfillmentMethod>STORE_PICK_UP</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<ReleaseStatuses>
<ReleaseStatus statusCode="3700.00.2000" statusDescription="Pickup Complete" quantity="1"
totalQuantity="1"/>
</ReleaseStatuses>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20210203</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderItems>
<Destination>
<StoreFrontDetail>
<StoreCode>568</StoreCode>
<StoreName>TEST STORE</StoreName>
<StoreEmail/>
<Address>
<Line1>123 ROAD</Line1>
<Line2>SUITE A</Line2>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60632</PostalCode>
</Address>
<StoreDirections/>
<StoreHours>09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|09:30 AM - 09:00 PM|11:00 AM - 07:00 PM</StoreHours>
<StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
</StoreFrontDetail>
</Destination>
</OrderPickupReminder>
<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReminderList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="00081o52811113"
storeId="StoreCode"
locale="en_US"
orderDate="2021-02-06T13:17:51+00:00"
currencySymbol="$"
currency="USD">
<Customer>
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Stockbridge</City>
<MainDivision>GA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>30281</PostalCode>
</Address>
<PhoneNumber/>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<OrderItems>
<OrderItem webLineId="1" itemId="67-1163367">
<Description>
<Description>Crocs Mercy Work Slip Resistant</Description>
<SKU>41401786</SKU>
<UPC/>
<GlobalId/>
<Title>Crocs Mercy Work Slip Resistant</Title>
<Color id="28235">Black/Silver</Color>
<Size id="50435">8M</Size>
<StyleNumber/>
</Description>
<Pricing>
<Amount>33.90</Amount>
<UnitPrice>39.98</UnitPrice>
</Pricing>
<FulfillmentMethod>STORE_PICK_UP</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<ReleaseStatuses>
<ReleaseStatus statusCode="3700.00.1000" statusDescription="Ready For Pickup" quantity="1"
totalQuantity="1"/>
</ReleaseStatuses>
<ProxyInformation>
<ProxyName>Proxy Pickup Person Name</ProxyName>
<ProxyFirstName/>
<ProxyLastName/>
<ProxyEmail>proxypersonemail@domain.com</ProxyEmail>
<ProxyPhone/>
<Relationship/>
</ProxyInformation>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20210213</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderItems>
<Destination>
<StoreFrontDetail>
<StoreCode>519</StoreCode>
<StoreName>TEST STORE</StoreName>
<StoreEmail/>
<Address>
<Line1>123 BLVD</Line1>
<Line2>STE C</Line2>
<City>Smyrna</City>
<MainDivision>GA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>30080</PostalCode>
</Address>
<StoreDirections/>
<StoreHours>10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|10:00 AM - 09:00 PM|11:00 AM - 07:00 PM</StoreHours>
<StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
</StoreFrontDetail>
</Destination>
</OrderPickupReminderList>