Determine Eligibility for Associate Delivery

The Determine Eligibility for Associate Delivery operation is used to determine if store associates can deliver items at a node directly to customers.

URI Summary

Operation

Action

URI Template

URI Example

Transaction Type

Unique RequestID Needed for Duplicate Detection?

Non-URI Request / Payload

Response
Determine Associate Delivery eligibility POST /v M.m/stores/STOREID/inventory/associatedeliveryeligibility   For items in a shipping group, determine eligibility for Associate Delivery. No XML

200 + XML

response

URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:

https://apg.radial.com/v1.0/proxyname/storecode/function

You should have received the applicable information for proxyname, storecode, and function from your Radial representative.

Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.

Inventory

Examples

Request Message

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<AssociateDeliveryEligibilityRequestMessage xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <ShipGroups>
        <ShipGroup shipGroupId="1">
            <OrderItems>
                <OrderItem lineId="1" itemId="itemId1">
                    <Quantity>1</Quantity>
                    <ShipmentDetails addressRefId="ship1"/>
                </OrderItem>
            </OrderItems>
        </ShipGroup>
    </ShipGroups>
    <ShippingAddresses>
        <ShippingAddress addressRefId="ship1">
            <Line1>Line1</Line1>
            <Line2>Line2</Line2>
            <Line3>Line3</Line3>
            <Line4>Line4</Line4>
            <City>King of Prussia</City>
            <MainDivisionCode>PA</MainDivisionCode>
            <CountryCode>US</CountryCode>
            <PostalCode>19406</PostalCode>
        </ShippingAddress>
    </ShippingAddresses>
</AssociateDeliveryEligibilityRequestMessage>

Success Response

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<AssociateDeliveryEligibilityResponseMessage xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <ShipGroups>
        <ShipGroup shipGroupId="1">
            <IsAssociateDeliveryEligible>false</IsAssociateDeliveryEligible>
        </ShipGroup>
    </ShipGroups>
</AssociateDeliveryEligibilityResponseMessage>

400 Error Response

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<Fault 
    xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <CreateTimestamp>2018-06-05T16:13:49+00:00</CreateTimestamp>
    <Code>InvalidRequestXmlException</Code>
    <Description>cvc-complex-type.2.4.b: The content of element 'OrderItem' is not complete. 
One of '{"http://api.gsicommerce.com/schema/checkout/1.0":Quantity}' is expected.</Description>
</Fault>

500 Error Response

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<Fault 
    xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <CreateTimestamp>2018-06-05T16:12:32.639Z</CreateTimestamp>
    <Code>ServiceSystemException</Code>
    <Description>GSIAPI-0003: Integration service responded to a request with an error response: runtime error</Description>
</Fault>