Order Pickup Ready Event

For in-store pickup orders, the Order Pickup Ready event is sent when the store notifies the Order Management System that the item is ready for the customer to pick up.

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 OrderPIckupReady message.
If you use the webhooks-based implementation, a set of events is grouped together in an OrderPickupReadyList message.

Schemas:

Order Pickup Ready Event Types:

Ready for pickup message
Ready for pickup proxy message

XPath: /OrderPickupReady/OrderItem/

Proxy event will have extra ProxyInformation. For example:

Copy

<ProxyInformation>
     <ProxyName>Proxy Pickup Person Name</ProxyName>
     <ProxyFirstName/>
     <ProxyLastName/>
     <ProxyEmail>proxypersonemail@domain.com</ProxyEmail>
     <ProxyPhone/>
     <Relationship/>
</ProxyInformation>

OrderPickupReady Messages

For queue-based implementations, a new OrderPickupReady message is generated for each new event.

Queue name: q.Order.Pickup.Ready.<StoreCode>.2-0

Single-Event Message Examples

Click any heading below to view the contents of the sample message file.

Sample Message: Ready for Pickup

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReady xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                  customerOrderId="00081910011111123"
                  storeId="StoreCode"
                  locale="en_US"
                  orderDate="2021-01-26T14:39:00+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>Hudsonville</City>
         <MainDivision>MI</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>49426</PostalCode>
      </Address>
      <PhoneNumber/>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderItems>
      <OrderItem webLineId="1" itemId="67-163702">
         <Description>
            <Description>Converse Chuck Taylor All Star Canvas Hi</Description>
            <SKU>41402156</SKU>
            <UPC/>
            <GlobalId/>
            <Title>Converse Chuck Taylor All Star Canvas Hi</Title>
            <Color id="167742">Black</Color>
            <Size id="50435">Men's 8 / Women's 10M</Size>
            <StyleNumber/>
         </Description>
         <Pricing>
            <Amount>63.60</Amount>
            <UnitPrice>60.00</UnitPrice>
         </Pricing>
         <FulfillmentMethod>SHIP_TO_STORE</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <ReleaseStatuses>
            <ReleaseStatus statusCode="3700.00.1000" statusDescription="Ready For Pickup" quantity="1"
                           shipmentQuantity="1"
                           totalQuantity="1"/>
         </ReleaseStatuses>
         <AdditionalValues>
            <KeyValuePair>
               <Key>PickupDate</Key>
               <Value>20210209</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>545</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123 SW</Line1>
            <City>GRANDVILLE</City>
            <MainDivision>MI</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>12345</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:30 PM|09:30 AM - 09:30 PM|11:00 AM - 07:00 PM</StoreHours>
         <StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
      </StoreFrontDetail>
   </Destination>
</OrderPickupReady>

Sample Message: Ready for Pickup by Proxy

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReady xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                  customerOrderId="00081o5211112"
                  storeId="StoreCode"
                  locale="en_US"
                  orderDate="2021-02-10T20:29:25+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>Memphis</City>
         <MainDivision>TN</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>38128</PostalCode>
      </Address>
      <PhoneNumber/>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderItems>
      <OrderItem webLineId="1" itemId="67-1537765">
         <Description>
            <Description>Bandolino Zurina</Description>
            <SKU>42700996</SKU>
            <UPC/>
            <GlobalId/>
            <Title>Bandolino Zurina</Title>
            <Color id="169008">White Smooth</Color>
            <Size id="50455">8.5M</Size>
            <StyleNumber/>
         </Description>
         <Pricing>
            <Amount>41.08</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"
                           shipmentQuantity="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>20210217</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>391</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123  DRIVE</Line1>
            <City>Collierville</City>
            <MainDivision>TN</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>12345</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>
</OrderPickupReady>

OrderPickupReadyList Messages

For Webhooks-based events, Order Pickup Ready events are grouped together in one OrderPickupReadyList message.

Event List Message Examples

Click any heading below to view the contents of the sample message file.

Sample Message: Ready for Pickup

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReadyList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                  customerOrderId="00081910011111123"
                  storeId="StoreCode"
                  locale="en_US"
                  orderDate="2021-01-26T14:39:00+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>Hudsonville</City>
         <MainDivision>MI</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>49426</PostalCode>
      </Address>
      <PhoneNumber/>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderItems>
      <OrderItem webLineId="1" itemId="67-163702">
         <Description>
            <Description>Converse Chuck Taylor All Star Canvas Hi</Description>
            <SKU>41402156</SKU>
            <UPC/>
            <GlobalId/>
            <Title>Converse Chuck Taylor All Star Canvas Hi</Title>
            <Color id="167742">Black</Color>
            <Size id="50435">Men's 8 / Women's 10M</Size>
            <StyleNumber/>
         </Description>
         <Pricing>
            <Amount>63.60</Amount>
            <UnitPrice>60.00</UnitPrice>
         </Pricing>
         <FulfillmentMethod>SHIP_TO_STORE</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <ReleaseStatuses>
            <ReleaseStatus statusCode="3700.00.1000" statusDescription="Ready For Pickup" quantity="1"
                           shipmentQuantity="1"
                           totalQuantity="1"/>
         </ReleaseStatuses>
         <AdditionalValues>
            <KeyValuePair>
               <Key>PickupDate</Key>
               <Value>20210209</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>545</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123 SW</Line1>
            <City>GRANDVILLE</City>
            <MainDivision>MI</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>12345</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:30 PM|09:30 AM - 09:30 PM|11:00 AM - 07:00 PM</StoreHours>
         <StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
      </StoreFrontDetail>
   </Destination>
</OrderPickupReadyList>

Sample Message: Ready for Pickup by Proxy

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupReadyList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                  customerOrderId="00081o5211112"
                  storeId="StoreCode"
                  locale="en_US"
                  orderDate="2021-02-10T20:29:25+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>Memphis</City>
         <MainDivision>TN</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>38128</PostalCode>
      </Address>
      <PhoneNumber/>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderItems>
      <OrderItem webLineId="1" itemId="67-1537765">
         <Description>
            <Description>Bandolino Zurina</Description>
            <SKU>42700996</SKU>
            <UPC/>
            <GlobalId/>
            <Title>Bandolino Zurina</Title>
            <Color id="169008">White Smooth</Color>
            <Size id="50455">8.5M</Size>
            <StyleNumber/>
         </Description>
         <Pricing>
            <Amount>41.08</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"
                           shipmentQuantity="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>20210217</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>391</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123  DRIVE</Line1>
            <City>Collierville</City>
            <MainDivision>TN</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>12345</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>
</OrderPickupReadyList>