Claim

Owned by Paul Pingaud (Deactivated)
Oct 07, 2022
3 min read

During orchestration process, orders are offered to one or multiple store locations.
Users of these store locations can “catch” them - this action is called “claim”.
When an order is claimed, this order is owned by the store location and is no longer claimable by the other store locations and orchestration process is stopped.

 

First store location to claim get the order.
Multiple store locations may claim a same order at same time. Only one store location will get the order while the others will have an error displayed.

Claimable orders are displayed on claim page of Vendor Interface.
List of claimable orders is automatically updated.
There is no need to manually refresh the page.

Information of claimable orders are defined in configuration of Vendor Interface
Default information includes types, delivery.type, state, information, line_items.item_id, line_items.unique_candidate, line_item_ids, line_items.state, line_items.payment.price, line_items.payment.currency, date, payment.currency, exclusive_line_items
This information can be enhanced by setting Vendor Interface configuration key page_request_additional_fields.claim

Claimable orders can be displayed in a specific order.
Default order is

  1. by delivery type ( delivery.type of the order ) in ascending order (1<…<9<A<…<Z)

  2. then first if there is only one store location eligible and then if not ( exclusive_lis of the order in descending order (true<false) )

  3. then by date ( date of the order ) in ascending order (1970<2022)

  4. then by id ( _id of the order ) in ascending order (1<…<9<A<…<Z)

This order is defined in the configuration of Vendor Interface by overwriting the key page_requests.claim.sort

Sorting is always alphabetical ( ascending: 1<…<9<A<…<Z) , numerical (ascending: 1<2<…<11<…) or binary (ascending: false < true)
Only ascending and descending orders are available. Custom sorting is not possible.

BestCompanyEver wants to sort claimable orders using delivery type, then inside these groups by exclusive eligibility, then by date.
This sorting is the same as the one by default so no sepcific configuration of vendor interface required.

BestCompanyEver wants that orders with SameDay delivery to be the first displayed, then the ones with Express delivery then Standard delivery.
SameDay < Express < Standard is not following alphabetical order - it is a custom order
Since custom order is not possible, BestCompanyEver must :

  • set order with Sameday delivery delivery.type: 1_SameDay

  • set order with Express delivery delivery.type: 2_Express

  • set order with Standard delivery delivery.type: 3_Standard

Based on that, if the following orders are claimable:

  • Order1 with _id: Order1 , delivery.type: 1_SameDay , exclusive_lis: false, date: 01/01/2000

  • Order2 with _id: Order2 , delivery.type: 2_Express , exclusive_lis: false, date: 01/01/2000

  • Order3 with _id: Order3 , delivery.type: 3_Standard , exclusive_lis: false, date: 02/01/2000

  • Order4 with _id: Order4 , delivery.type: 1_SameDay , exclusive_lis: false, date: 01/01/2000

  • Order5 with _id: Order5 , delivery.type: 1_SameDay , exclusive_lis: true, date: 01/01/2000

  • Order6 with _id: Order6 , delivery.type: 3_Standard , exclusive_lis: true, date: 01/01/2000

  • Order7 with _id: Order7 , delivery.type: 3_Standard , exclusive_lis: true, date: 01/01/2000

The displayed list will be :

Order5 < Order1 < Order 4 < Order2 < Order6 < Order7< Order3

 

If BestCompanyEver wants to display orders with only one store location eligible, then by delivery type, a modification of vendor interface configuration will be required