White Glove API Examples

Advanced Shipment Notice (ASN) from Client

<?xml version="1.0" encoding="UTF-8"?> <Booking> <SourceRef>R353222002</SourceRef> <ExternalMatchingRef></ExternalMatchingRef> <BookingReason>ASN</BookingReason> <IsReturn></IsReturn> <Incoterms></Incoterms> <IncotermsLocation></IncotermsLocation> <SourceCreationTime>2022-01-25T13:04:30.500Z</SourceCreationTime> <!-- No Consignor / Consignee or Client organisations will be provided --> <Organisations></Organisations> <Goods> <GoodsItem> <Description>left wall</Description> <SKU>S02345332</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>30</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>right wall</Description> <SKU>S02345349</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>30</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>rear wall</Description> <SKU>S02345336</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>60</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>front wall</Description> <SKU>S02345356</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>50</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>floor</Description> <SKU>S02345378</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>50</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>roof</Description> <SKU>S02345389</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>60</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> </Goods> <Transit> <TransitMode>ROAD</TransitMode> <AdditionalInfo>big red lorry</AdditionalInfo> <!-- No container information provided --> <Containers></Containers> </Transit> <ReceiveFrom> <AgentCode>XPOLOGISTICS</AgentCode> <AgentName>XPO Logistics Ltd</AgentName> <AdditionalInfo>stuff</AdditionalInfo> </ReceiveFrom> <!-- No handover-to information provided or applicable --> <HandoverTo></HandoverTo> <!-- No collection location or time provided or applicable for ASN --> <Collection></Collection> <CollectionWindow></CollectionWindow> <Delivery> <Location> <Code>SEKOGB</Code> <Name>SEKO Warehouse</Name> <AddressLine1>High Standing</AddressLine1> <AddressLine2>Harding Road</AddressLine2> <City>Milton Keynes</City> <Postcode>MK10 0DF</Postcode> <CountryCode>GB</CountryCode> </Location> </Delivery> <DeliveryWindow> <Earliest></Earliest> <Latest>2022-01-27T13:04:30.500Z</Latest> </DeliveryWindow> </Booking>

 

Inbound Booking / Goods Transfer request from Client

<?xml version="1.0" encoding="UTF-8"?> <Booking> <SourceRef>R353225423</SourceRef> <ExternalMatchingRef></ExternalMatchingRef> <BookingReason>GOODS_TRANSFER</BookingReason> <IsReturn></IsReturn> <Incoterms></Incoterms> <IncotermsLocation></IncotermsLocation> <SourceCreationTime>2022-01-25T14:09:30.500Z</SourceCreationTime> <!-- No Consignor / Consignee or Client organisations will be provided --> <Organisations></Organisations> <Goods> <GoodsItem> <Description>walls</Description> <SKU>S02345332</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>20</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>rear wall</Description> <SKU>S02345336</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>10</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>front wall</Description> <SKU>S02345356</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>10</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>floor</Description> <SKU>S02345378</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>10</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> <GoodsItem> <Description>roof</Description> <SKU>S02345389</SKU> <SalesOrderLineID></SalesOrderLineID> <Quantity>25</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods></ChildGoods> </GoodsItem> </Goods> <!-- Transit not strictly necessary as we are arranging the transport --> <Transit> <TransitMode>ROAD</TransitMode> <AdditionalInfo></AdditionalInfo> <!-- No container information provided --> <Containers></Containers> </Transit> <!-- No Receive from or Handover-to information provided --> <ReceiveFrom></ReceiveFrom> <HandoverTo></HandoverTo> <Collection> <Location> <Code>XYZABC</Code> <Name>ROOM Factory A</Name> <AddressLine1>Ind Area 1</AddressLine1> <AddressLine2>Roading Street</AddressLine2> <City>Hull</City> <Postcode>HL5 5GH</Postcode> <CountryCode>GB</CountryCode> </Location> <Contact> <ContactName>Rupert</ContactName> <EmailAddress>rupert@roomfactory.co.uk</EmailAddress> <ContactNumber>01211 343132</ContactNumber> </Contact> </Collection> <CollectionWindow> <Earliest></Earliest> <Latest>2022-01-30T00:00:00.000Z</Latest> </CollectionWindow> <Delivery> <Location> <Code>SEKOGB</Code> <Name>SEKO Warehouse</Name> <AddressLine1>High Standing</AddressLine1> <AddressLine2>Harding Road</AddressLine2> <City>Milton Keynes</City> <Postcode>MK10 0DF</Postcode> <CountryCode>GB</CountryCode> </Location> </Delivery> <DeliveryWindow> <Earliest></Earliest> <Latest>2022-01-31T18:00:00.000Z</Latest> </DeliveryWindow> </Booking>

 

Outbound Booking / Fulfil Client Sales Order

<?xml version="1.0" encoding="UTF-8"?> <Booking> <SourceRef>R353226570</SourceRef> <ExternalMatchingRef></ExternalMatchingRef> <BookingReason>SALES_ORDER</BookingReason> <IsReturn></IsReturn> <Incoterms></Incoterms> <IncotermsLocation></IncotermsLocation> <SourceCreationTime>2022-01-25T15:19:30.500Z</SourceCreationTime> <!-- No Consignor / Consignee or Client organisations will be provided --> <Organisations></Organisations> <Goods> <GoodsItem> <Description>ROOM office pod STANDARD</Description> <SKU>S001211356</SKU> <SalesOrderLineID>1</SalesOrderLineID> <Quantity>2</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods> <ChildGoodsItem> <Description>left wall</Description> <SKU>S02345332</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>right wall</Description> <SKU>S02345349</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>rear wall</Description> <SKU>S02345336</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>front wall</Description> <SKU>S02345356</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>floor</Description> <SKU>S02345378</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>roof</Description> <SKU>S02345389</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> </ChildGoods> </GoodsItem> <GoodsItem> <Description>ROOM office pod DELUXE</Description> <SKU>S001211357</SKU> <SalesOrderLineID>2</SalesOrderLineID> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> <Condition></Condition> <ChildGoods> <ChildGoodsItem> <Description>left wall</Description> <SKU>S02345332</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>right wall</Description> <SKU>S02345349</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>rear wall</Description> <SKU>S02345336</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>front wall</Description> <SKU>S02345358</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>floor</Description> <SKU>S02345378</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> <ChildGoodsItem> <Description>roof</Description> <SKU>S02345391</SKU> <Quantity>1</Quantity> <QuantityUnit>PCS</QuantityUnit> </ChildGoodsItem> </ChildGoods> </GoodsItem> </Goods> <!-- Transit not strictly necessary as we are arranging the transport --> <Transit> <TransitMode>ROAD</TransitMode> <AdditionalInfo></AdditionalInfo> <!-- No container information provided --> <Containers></Containers> </Transit> <!-- No Receive From information provided --> <Collection> <Location> <Code>SEKOGB</Code> <Name>SEKO Warehouse</Name> <AddressLine1>High Standing</AddressLine1> <AddressLine2>Harding Road</AddressLine2> <City>Milton Keynes</City> <Postcode>MK10 0DF</Postcode> <CountryCode>GB</CountryCode> </Location> <Contact></Contact> </Collection> <CollectionWindow> <Earliest></Earliest> <Latest>2022-02-08T12:00:00.000Z</Latest> </CollectionWindow> <Delivery> <Location> <Code>XYZ987</Code> <Name>Barney Rubble Ltd</Name> <AddressLine1>12 Market Avenue</AddressLine1> <AddressLine2></AddressLine2> <City>Southampton</City> <Postcode>SO23 3HQ</Postcode> <CountryCode>GB</CountryCode> </Location> <Contact> <ContactName>Joan Smith</ContactName> <EmailAddress>jsmith@barneyrubble.co.uk</EmailAddress> <ContactNumber></ContactNumber> </Contact> </Delivery> <DeliveryWindow> <Earliest></Earliest> <Latest>2022-02-18T12:00:00.000Z</Latest> </DeliveryWindow> <WhiteGlove> <AssemblyRequired>TRUE</AssemblyRequired> <AdditionalInfo>doors may be a bit narrow?</AdditionalInfo> </WhiteGlove> <GoodsAllocation> <AllocateGoodsFromRef>R353225423</AllocateGoodsFromRef> </GoodsAllocation> </Booking>

 

Example Booking API Response Message

The API response will either be Success or Failure.

In the event of Success, an internally-generated SEKO ID for the booking will be returned and no error messages will be returned.

 

In the event of Failure, no internally-generated SEKO ID for this booking will be returned, but one or more error messages (depending on which part(s) failed validation) will be returned.

Â