Order Pickup Complete Event

For in-store pickup orders, the Order Pickup Complete event is sent when an item has been picked up from the store.

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

Schemas:

Order Pickup Complete Event Types:

Pickup complete message
Pickup complete proxy message

XPath: /OrderPickupComplete/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>

OrderPickupComplete Messages

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

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

Single-Event Message Examples

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

Sample Message: Pickup Complete

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupComplete xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                     customerOrderId="01610111113"
                     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>KOP</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.2000" statusDescription="Pickup Complete" 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>link</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </OrderItems>
   <Destination>
      <StoreFrontDetail>
         <StoreCode>111</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123 TEST AVE SW</Line1>
            <City>KOP</City>
            <MainDivision>PA</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>
</OrderPickupComplete>

Sample Message: Pickup Complete by Proxy

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupComplete xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                     customerOrderId="000819114111110123"
                     storeId="StoreCode"
                     locale="en_US"
                     orderDate="2021-02-07T01:17: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>KOP</City>
         <MainDivision>TX</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>78503</PostalCode>
      </Address>
      <PhoneNumber/>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderItems>
      <OrderItem webLineId="1" itemId="67-1550994">
         <Description>
            <Description>Nike Air Max Invigor 3.5-7</Description>
            <SKU>42908059</SKU>
            <UPC/>
            <GlobalId/>
            <Title>Nike Air Max Invigor 3.5-7</Title>
            <Color id="170297">WlfGy/Vlt/Blk</Color>
            <Size id="50395">7M</Size>
            <StyleNumber/>
         </Description>
         <Pricing>
            <Amount>43.20</Amount>
            <UnitPrice>40.00</UnitPrice>
         </Pricing>
         <FulfillmentMethod>SHIP_TO_STORE</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <ReleaseStatuses>
            <ReleaseStatus statusCode="3700.00.2000" statusDescription="Pickup Complete" 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>20210220</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>PickupTime</Key>
               <Value>235900</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>ImageLink</Key>
               <Value>link</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </OrderItems>
   <Destination>
      <StoreFrontDetail>
         <StoreCode>255</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123  EXPRESSWAY 83</Line1>
            <City>KOP</City>
            <MainDivision>TX</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>78503</PostalCode>
         </Address>
         <StoreDirections/>
         <StoreHours>09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|10:00 AM - 07:00 PM</StoreHours>
         <StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
      </StoreFrontDetail>
   </Destination>
</OrderPickupComplete>

OrderPickupCompleteList Messages

For Webhooks-based implementations, Order Pickup Complete events are grouped together in one OrderPickupCompleteList message.

Event List Message Examples

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

Sample Message: Pickup Complete

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupCompleteList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                     customerOrderId="01610111113"
                     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>KOP</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.2000" statusDescription="Pickup Complete" 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>link</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </OrderItems>
   <Destination>
      <StoreFrontDetail>
         <StoreCode>111</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123 TEST AVE SW</Line1>
            <City>KOP</City>
            <MainDivision>PA</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>
</OrderPickupCompleteList>

Sample Message: Pickup Complete by Proxy

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderPickupCompleteList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                     customerOrderId="000819114111110123"
                     storeId="StoreCode"
                     locale="en_US"
                     orderDate="2021-02-07T01:17: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>KOP</City>
         <MainDivision>TX</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>78503</PostalCode>
      </Address>
      <PhoneNumber/>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderItems>
      <OrderItem webLineId="1" itemId="67-1550994">
         <Description>
            <Description>Nike Air Max Invigor 3.5-7</Description>
            <SKU>42908059</SKU>
            <UPC/>
            <GlobalId/>
            <Title>Nike Air Max Invigor 3.5-7</Title>
            <Color id="170297">WlfGy/Vlt/Blk</Color>
            <Size id="50395">7M</Size>
            <StyleNumber/>
         </Description>
         <Pricing>
            <Amount>43.20</Amount>
            <UnitPrice>40.00</UnitPrice>
         </Pricing>
         <FulfillmentMethod>SHIP_TO_STORE</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <ReleaseStatuses>
            <ReleaseStatus statusCode="3700.00.2000" statusDescription="Pickup Complete" 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>20210220</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>PickupTime</Key>
               <Value>235900</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>ImageLink</Key>
               <Value>link</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </OrderItems>
   <Destination>
      <StoreFrontDetail>
         <StoreCode>255</StoreCode>
         <StoreName>TEST STORE</StoreName>
         <StoreEmail/>
         <Address>
            <Line1>123  EXPRESSWAY 83</Line1>
            <City>KOP</City>
            <MainDivision>TX</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>78503</PostalCode>
         </Address>
         <StoreDirections/>
         <StoreHours>09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|09:30 AM - 09:30 PM|10:00 AM - 07:00 PM</StoreHours>
         <StoreFrontPhoneNumber>123456789</StoreFrontPhoneNumber>
      </StoreFrontDetail>
   </Destination>
</OrderPickupCompleteList>