Nearshop (Seller App) — compliance checks

sandeepshahi commented 7 months ago

- use log validation utility to test the logs before submission

Flow 1

/on_search

"accept_bap_terms" object should not be provided (not a part of phase 1); and is used to accept static terms provided by BAP in /search
holidays should be future dated
invalid enum value of quantity/unitized/measure/unit; check contract for the correct enum
@ondc/org/mandatory_reqs_veggies_fruits property is not required
value of @ondc/org/return_window must be provided to define IGM window
available count should be either 99/0 and only determines the availability of stock

/on_search (inc)

city code should be * in incremental refresh calls
full catalog should not be provided as part of incremental on_search; check contract for required properties
no delta incremental changes provided in the catalog
only the incremental changes within the specified time range should be provided

FLow 2

/select

selected item not available in the catalog

/on_select

available count in quote/breakup for item should be either 99/0; as mentioned in on_search
fulfillment level tax should have fulfillment id in "@ondc/org/item_id"; for item, the prices should be tax inclusive; fulfillment level tax is not a part of pahse 1;
quote/price should be = sum of quote/breakup/price

/on_init

quote object can't change
provider_location is deprecated

use the log validation utility before submitting the logs

Flow 3

check contract for OOS scenario; error message should be in the correct format

Flow 4

invalid cancellation flow; check contract

Flow 5

invalid RTO flow; check contract

submit the logs as per the test case scenarios

Flow 6

invalid return flow; return must be initiated before liquidating
check the contract for handling the returns where new fulfillment is created;

@RonitKumarSinha

RonitKumarSinha commented 7 months ago

@bluecypher Please Clarify..

Below are three Points:

fullement ID for tax, even passing fullment ID utility tool is throwing error.
provider location new format - which is correct? Utility tool is throwing an error and the document is not synced.
Please clarify in case of fruits and veggies category ,product detatils has to be sent or not. This is not mentioned in spec document but asked in review comment

RonitKumarSinha commented 7 months ago

@bluecypher Need your help/clarification on above mentioned points

sahil-ondc commented 6 months ago

Flow 1

on_search_full_catalog

/message/catalog/bpp/descriptor/tags must have required property 'list'
/message/catalog/bpp/descriptor/tags must NOT have additional properties (value)
/message/catalog/bpp/providers/items/tags must have Attribute tag fields (mandatory attr Brand)

on_search_inc_catalog

bpp/fulfillments sent in payload shoulnd't be part of /on_search_inc_refresh api
bpp/descriptor sent in payload shoulnd't be part of /on_search_inc_refresh api
location label (/bpp/providers/locations/time/label) for /on_search_inc_refresh should not be equal to /on_search_full_catalog_refresh.label

Other Flows

select

Timestamp for /on_search api cannot be greater than or equal to /select api

on_select

Timestamp for /select api cannot be greater than or equal to /on_select api

init

address.building should be more than 3 chars

on_init

Timestamp for init api cannot be greater than or equal to on_init api
only tax_number should be provided in /message/order/tags/bpp_terms
tax number should be valid should not be provided as placeholder

confirm

/message/order/payment/params must have required property 'transaction_id'

on_confirm

/message/order/fulfillments/0/start/location/address must have required property 'locality'
/message/order/fulfillments/0/start/location/address must have required property 'city'
/message/order/payment/params must have required property 'transaction_id'
/context/timestamp for /confirm api cannot be greater than or equal to /on_confirm api
order.updated_at timestamp should be updated as per the context.timestamp (since default fulfillment state is added)
Number of digits in tax number in message.order.tags[0].list should be 15
only provider_tax_number and tax_number should be provided in /message/order/tags/bpp_terms

@RonitKumarSinha

sahil-ondc commented 6 months ago

Flow 1

on_search_full_catalog

/message/catalog/bpp/providers/items/category_id should be one of the ids provided in sheet https://docs.google.com/spreadsheets/d/1APAvavF_BNbTA89benAlGtv0GuFvpn2b6XXi4lSdTTw/edit#gid=983332432
/message/catalog/bpp/providers/items/tags/origin value should be in 'ISO 3166-1 alpha-3 code' format
/message/catalog/bpp/providers/items/tags/attributes should have mandatory attributes as per the sheet https://docs.google.com/spreadsheets/d/1APAvavF_BNbTA89benAlGtv0GuFvpn2b6XXi4lSdTTw/edit#gid=983332432

on_search_inc_catalog

/context must have required property 'bpp_id'
/context must have required property 'bpp_uri'
/context/action must be equal to constant (on_search)
location label (/bpp/providers/locations/time/label) for /on_search_inc_refresh should not be equal to /on_search_full_catalog_refresh.label
additional properties should not be provided in on_search_inc (descriptor, tags, locations, fulfillments)

Flow 2

on_status (picked)

/message/order/fulfillments/0 must have required property '@ondc/org/TAT'
/message/order/fulfillments/0/start/location/address must have required property 'locality'
/message/order/fulfillments/0/start/location/address must have required property 'city'
/message/order/payment/params must have required property 'transaction_id'
context/transaction_id should same as select context/transaction_id
/message/order/id in /confirm and /on_status should be same

on_status (out-for-delivery)

/message/order/tags/bpp_terms/tax_number should be same as provided in provided in /confirm
only tax_number and provider_tax_number should be provided in /tags/bpp_terms; remove other terms related properties

Flow 3

sucessful select call should be provided

Flow 4

invalid flow provided (flows should be submitted as per the sheet) https://docs.google.com/spreadsheets/d/1JZV6ZQzXcHUsOwegGtArX3DdIXYIy3gxkhQ00q7kICc/edit#gid=1367601795
order should be cancelled before pickup

Flow 5

on_status (rto-disposed)

Transactional logs should be as per the API contract

Note

on_search_full_catalog

/message/catalog/bpp/providers/items/descriptor short_desc long_desc and name should have unique values
Is vairants supported ?

@RonitKumarSinha

sumit5219 commented 6 months ago

Hi @sahil-ondc Once this is merged we can review again. As we discussed yesterday fixes are taken care - https://github.com/ONDC-Official/v1.2.0-logs/pull/983

Flow1: Fixed

Flow2:

on_status (picked) /message/order/fulfillments/0 must have required property '@ondc/org/TAT' - Fixed /message/order/fulfillments/0/start/location/address must have required property 'locality' - Invalid /message/order/fulfillments/0/start/location/address must have required property 'city' - Invalid /message/order/payment/params must have required property 'transaction_id' - Invalid context/transaction_id should same as select context/transaction_id - Invalid /message/order/id in /confirm and /on_status should be same - Invalid

on_status (out-for-delivery) /message/order/tags/bpp_terms/tax_number should be same as provided in provided in /confirm - Invalid only tax_number and provider_tax_number should be provided in /tags/bpp_terms; remove other terms related properties - Invalid but added provider_tax_number too

Flow 3 sucessful select call should be provided - provided

Flow 4 invalid flow provided (flows should be submitted as per the sheet) - invalid as discussed was as per the sheet https://docs.google.com/spreadsheets/d/1JZV6ZQzXcHUsOwegGtArX3DdIXYIy3gxkhQ00q7kICc/edit#gid=1367601795 order should be cancelled before pickup - invalid

Flow 5 on_status (rto-disposed) Transactional logs should be as per the API contract - Fixed

Flow 6 No comments and communicated logs are good

/message/catalog/bpp/providers/items/descriptor short_desc long_desc and name should have unique values - yes it would be unique string in production Is vairants supported ? - No

sahil-ondc commented 6 months ago

Flow 1

search_inc

context/city should be '*' while sending search_inc_catalog request

on_search_full_catalog

/message/catalog/bpp/providers/items/@ondc/org/return_window should not be provided as ""

Flow 2

on_select

context/timestamp for /select api cannot be greater than or equal to /on_select api

on_init

/message/order/provider/locations must be object
context/timestamp for init api cannot be greater than or equal to on_init api

on_confirm

context/timestamp for /confirm api cannot be greater than or equal to /on_confirm api
np_type should be provided in /message/order/tags/bpp_terms
/message/order/updated_at cannot be smaller than created_at

on_status

packed fulfillment state should be provided
/message/order/updated_at cannot be smaller than created_at

Flow 3

same issues as above

Flow 4

Same issues as Flow 2

on_cancel

/message/order must NOT have additional properties (tags)
Timestamp for /cancel api cannot be greater than or equal to /on_cancel api
invalid quote mapping
Item count should be 0 for /on_cancel in forward shipment when item is cancelled
fulfillment type cancel is missing in /on_cancel
multiple issues kindly submit transaction logs as per API contract https://docs.google.com/document/d/1brvcltG_DagZ3kGr1ZZQk4hG4tze3zvcxmGV4NMTzr8/edit#heading=h.yzl8pn3ixxec

Flow 5

Same issues as above

Flow 6

same issues as above

on_update (accepted)

invalid quote provided

@sumit5219

sumit5219 commented 5 months ago

Hi @sahil-ondc , Once this is merged we can review again - https://github.com/ONDC-Official/v1.2.0-logs/pull/1104

Flow 1 Fixed

Flow 2 Fixed

/message/order/provider/locations must be object - v1.1 it was an object and now in v1.2 this has to array of object. The details are provided at top of this issue comment. Marking this as invalid as mentioned earlier too.

Flow 3 Fixed

Flow 4 Fixed

on_cancel - Fixed

Flow 5 Fixed

Flow 6 Fixed

on_update - Fixed

sahil-ondc commented 5 months ago

Flow 2

confirm

/message/order/id Should be alphanumeric upto 32 letters max

Flow 4

on_cancel

message/order/provider rateable is not a valid field according to api contract
/message/order/fulfillments/1/start not required for type cancel

Flow 5

on_cancel_rto_initiated

Pre Cancel is mandatory for on_cancel

confirm

on_confirm

context/timestamp for /confirm api cannot be greater than or equal to /on_confirm api
order.updated_at timestamp should be updated as per the context.timestamp (since default fulfillment state is added)

Flow 6: Reverse QC and Liquidation

Reverse QC

on_update_interim

Transaction logs for /on_update_interim should be provided

on_update_approval

/message/order must have required property 'provider'.
/message/order/fulfillments/0/start/contact must have required property 'email'.
Invalid CancellationID 002 or not allowed for BNP.

on_update_picked

/message/order/fulfillments/0/start/contact must have required property 'email'.

update_settlement

Transaction logs for /update_settlement should be provided

Liquidation

update

Reason ID is not a valid reason ID (buyer app initiated).

on_update_liquidated

/message/order must have required property 'provider'.
Quote trail price and item quote price sum for on_update should be equal to the price as in on_confirm.

@sumit5219

sumit5219 commented 5 months ago

Hi @sahil-ondc , As discussed with @sandeepshahi below valid comments are fixed once this PR is merged please review it https://github.com/ONDC-Official/v1.2.0-logs/pull/1164 again. Also as Flow 2 is the issue at buyer end so submitting the lgos for 4,5,6 flows only.

Flow 4 on_cancel message/order/provider rateable is not a valid field according to api contract - done /message/order/fulfillments/1/start not required for type cancel - done

Flow 5 on_cancel_rto_initiated Pre Cancel is mandatory for on_cancel - done confirm on_confirm context/timestamp for /confirm api cannot be greater than or equal to /on_confirm api - done order.updated_at timestamp should be updated as per the context.timestamp (since default fulfillment state is added) - done Flow 6: Reverse QC and Liquidation Reverse QC on_update_interim Transaction logs for /on_update_interim should be provided - was already provided on_update_approval /message/order must have required property 'provider'. - done /message/order/fulfillments/0/start/contact must have required property 'email'. - optional filed as discussed with Sandeep so ignoring this Invalid CancellationID 002 or not allowed for BNP. - invalid as per Sandeep as its frombuyer app as we checked.

on_update_picked /message/order/fulfillments/0/start/contact must have required property 'email'. - invalid as mentioned above update_settlement Transaction logs for /update_settlement should be provided - done Liquidation update Reason ID is not a valid reason ID (buyer app initiated). - invalid as its comes from buyer and same is used at seller on_update_liquidated /message/order must have required property 'provider'. - done Quote trail price and item quote price sum for on_update should be equal to the price as in on_confirm. - done

sahil-ondc commented 5 months ago

Flow 4

on_init

settlement_basis, settlement_window, withholding_amount in /payment should only be provided when BPP is collecting prepaid

on_cancel

updated_at provided in precancel_state should be valid timestamp when order was last updated

Flow 5

on_cancel

updated_at provided in precancel_state should be valid timestamp when order was last updated

Flow 6

part-cancellation

partial cancellation not provided

on_update (liquidation)

after liquidation liquidated item will be mapped to Liquidated fulfillment

on_updat (return-initiated-reverse-qc)

@ondc/org/settlement_details" should have refund settlement details of liquidated items as that is done before

on_updat (return-delivered)

@ondc/org/settlement_details" should have refund settlement details of liquidated and returned items as that is done before

Note

Buyer selects multiple items (> 1 qty for each item) for checkout (multiple items must be selected) as per the sheet https://docs.google.com/spreadsheets/d/1JZV6ZQzXcHUsOwegGtArX3DdIXYIy3gxkhQ00q7kICc/edit#gid=1367601795

@sumit5219

sumit5219 commented 5 months ago

Hi @sahil-ondc Review comments are fixed once https://github.com/ONDC-Official/v1.2.0-logs/pull/1185 is merged please review.

Note: Nearshop doesn't allow merchants to do any partial cancel of any order. So the logs of partial cancellation is not provided. But its present in our roadmap as we develop we will re inititate this cancel logs.

sahil-ondc commented 5 months ago

Flow 5

RTO-picked state missing

Flow 6

Partial Cancellation Logs should be provided as those are the mandatory for compliance.

@sumit5219

sumit5219 commented 5 months ago

Hi @sahil-ondc Partial Cancel workflow is implemented and submitted Once https://github.com/ONDC-Official/v1.2.0-logs/pull/1254 is merged please review

Flow 5 - invalid as its RTO disposed flow

Flow 6 - Partial Cancel logs are shared now

sahil-ondc commented 5 months ago

Flow 6

on_confirm

context/timestamp cannot be greater than on_update context/timestamp

on_update (part-cancel)

how return fulfillment exist in items.fulfillment (Return:1fdc91a4-2a95-426c-a479-fd953bd119e2) when order state is pending

@sumit5219

sumit5219 commented 5 months ago

Hi @sahil-ondc , Fixes are done once https://github.com/ONDC-Official/v1.2.0-logs/pull/1271 is merged please review.

sahil-ondc commented 5 months ago

Flow 1

item/descriptor/code missing and should be in this format for every item - "type:code" where type is 1 - EAN, 2 - ISBN, 3 - GTIN, 4 - HSN, 5 - others
bpp/descriptor/accept_bap_terms: accept_bap_terms is not required in bpp/descriptor/tags for now

on_update_liquidated

invldQuoteTrailPrices: quote_trail price and item quote price sum for on_update should be equal to the price as in on_confirm.

@sumit5219

sumit5219 commented 4 months ago

Hi @sahil-once https://github.com/ONDC-Official/v1.2.0-logs/pull/1397 is merged please review

bpp/descriptor/accept_bap_terms: accept_bap_terms is not required in bpp/descriptor/tags for now - invalid as this was never sent on_search invldQuoteTrailPrices - this was fixed earlier as checked its matching with on_confirm price of items with quote_trail for respective items

sandeepshahi commented 4 months ago

Flow 1

/on_search

tracking is not a valid property in bpp/fulfillments
collect_payment block is optional in bpp/descriptor/tags/bpp_terms
store timing should be provided in bpp/providers/tags
variants must be supported;
is only "Fruits and Vegetables" subcategory supported?
unitized measure for all the items is "1 kilogram". are all the other enums supported?
value of "@ondc/org/return_window" should be in valid ISO8601 duration format

/search (inc)

isn't push based inc search supported?

Flow 2

/on_select

buyer's location is beyond the serviceable region defined in the catalog; the serviceability needs to be defined accurately

/on_init

"@ondc/org/settlement_basis", "@ondc/org/settlement_window" and "@ondc/org/withholding_amount" are provided by the collector;
bpp_terms info (np_type) provided in /on_search must also cascade in the subsequent APIs

/on_confirm

estimated time ranges for pickup and delivery are incorrect; delivery cannot be scheduled before pickup; ranges must be in conformance with the time_to_ship and delivery TAT

/on_status

Agent-assigned state is missing
unsolicited trigger of all the status calls must be supported (packed and OFD states seem to be missing)
routing and tracking info must be provided on or before the agent is assigned

/on_track

how can tracking be activated even before the order is packed?
how can the invoice and tracking url be same?

Flow 3, 4

similar issues as above

Flow 5

similar issues as above

RTO

start/end location must be provided for RTO fulfillment

rto disposed

each unsolicited call must have a unique message_id
order/updated_at can't be the same as in the initiated call

Flow 6

/on_update (return)

invalid fulfillment id for Return; should be the same as provided by BNP in /update

/on_update (liquidated)

message_id should be unique for unsolicited call
order/updated_at can't be the same as in the initiated call

/on_update (reverse qc)

message_id should be unique for unsolicited call
order/updated_at can't be the same as in the initiated call
trail is not maintained correctly; fulfillment state of previous return is not captured correctly (should be "Liquidated")
returned item should be mapped to the Return type fulfillment only once the order is picked (ie. reverse qc is successful); check /items and /quote and /quote_trail in return approved state
start and end location must be provided in Return fulfillment once the return is approved along with the estimated time ranges
actual return pickup and delivery timestamp must be provided in the required states

@sumit5219

sumit5219 commented 4 months ago

Hi @sandeepshahi Once https://github.com/ONDC-Official/v1.2.0-logs/pull/1544 is merged please review. Above invalid comments are resolved.

Details here as per the ONDC call and comments - https://docs.google.com/document/d/1GJTN1YxxdEZV1XfA1e2gotfBXvmbZUmvKDYSWzry52k/edit?usp=sharing

sahil-ondc commented 4 months ago

Flow 1

on_search (full_catalog)

context/message_id for /search and /on_search api should be same
context/transaction_id for /search and /on_search api should be same
code should have 1:EAN as a value in /message/catalog/bpp/providers[0]/items[0]/descriptor
placeholders should not be provided in /message/catalog/bpp/providers[0]/categories/descriptor/name
in case of variants (items having same parent_item_id) /item/quantity/unitized/measure should not be same

on_search (inc_catalog)

why context/transaction_id is matching with search (full_catalog) context/transaction_id
code should have 1:EAN as a value in /message/catalog/bpp/providers[0]/items[0]/descriptor

Flow 2, 3

on_status

invoice should not be webpage url
pickup timestamps not captured correctly
routing and tracking info must be provided on or before the agent is assigned

Flow 5

on_cancel, on_status

rto fulfillment - pickup and delivered timestamp is not captured correctly

Flow 6

Issues still persist as per last feedback

Note

on_search

short_desc and long_desc should not be same
in case of same timings and days, use type 'All' @sumit5219

sumit5219 commented 4 months ago

Hi @sahil-ondc , issues as mentioned above are fixed. Please review once this PR is merged https://github.com/ONDC-Official/v1.2.0-logs/pull/1582

sahil-ondc commented 3 months ago

Flow 1

on_search (full_catalog)

code should have 1:EAN as a value in /message/catalog/bpp/providers[0]/items[0]/descriptor
placeholders should not be provided in /message/catalog/bpp/providers[0]/categories/descriptor/name
all urls provided should be publically accessible (https://storage.googleapis.com/nslive/23e4abfe-913d-5c04-813e-ae60f95c11d9/raw/1702362919005_Arbi jad | Colocasia roots.png)
for item/quantity/unitized/measure clarity should be provided or please revise accordingly (how Arbi jad | Colocasia roots is added as 1 gm)

on_search (inc_catalog)

/context/timestamp must match format \"rfc3339-date-time\"
code should have 1:EAN as a value in /message/catalog/bpp/providers[0]/items[0]/descriptor
/message/catalog/bpp/providers/0/items/0/time/timestamp must match format \"rfc3339-date-time\"

Flow 2, 3

on_status

invoice provided should be publically accessible (https://storage.googleapis.com/nslive/2024-05-07-880680_invoice.pdf)
expected pickup range and expected delivery range cannot be same

Flow 5

on_cancel (rto)

invalid quote as for cancellation https://docs.google.com/document/d/1brvcltG_DagZ3kGr1ZZQk4hG4tze3zvcxmGV4NMTzr8/edit#heading=h.p49oiq6osp4

on_status (rto-disposed)

invalid quote

Flow 6

Same as above

@sumit5219

sumit5219 commented 3 months ago

Hi @sahil-ondc Please review once this is merged https://github.com/ONDC-Official/v1.2.0-logs/pull/1628

Flow1 Fixed @sandeepshahi has confirmed for Fruits and Vegetables it has to be 5:EAN as it was already sent in same format All URLs were already public, seems the copy of URL was not done proper and pasted over browser while reviewing.

Flow 2 & 3 Fixed

Flow 5 Fixed

Flow 6 Above issues automatically fixed and updated logs

sumit5219 commented 3 months ago

Hi @sandeepshahi , Below is the video demo for incremental search.

backend service logs which sends in every one minute
Merchant app updating products price, as soon the update is done in next a minute the on_search is send.

https://drive.google.com/drive/folders/19lxGO_xjLfkoImF7TrpORqIL2l2OELsx?usp=sharing

sandeepshahi commented 3 months ago

Flow 1

/on_search

timing provided in /tags/timing and /locations/time/range must match; check "time_from" vs "range.start"

/on_search (inc)

message_id (of unsolicited calls) should be unique for push based incremental search

Flow 2

/on_select

tags are not required in /order; may get rejected by BNPs for extra attributes

/on_init

callback response should not take long

/on_status

invoice and tracking url must be accessible
actual pickup/delivery timestamp should not change in subsequent APIs

/on_track

even though "gps_enabled" was set as "no", gps is still provided here; placeholder values should not be provided

Flow 3,4

similar issues as above

Flow 5

rto initiated

updated_at timestamp of precancel_state is not captured correctly; should be of Out-for-delivery state here

Flow 6

/on_update (part cancel)

part cancelled fulfillment id is created using the item id. How is part cancellation of multi items handled?

/on_status

duplicate tag elements: "routing" and "tracking" should be removed

/on_update (Return Approved)

items should not be mapped to the return fulfillment until reverseqc is successful (ie. return is picked)
quote and quote_trail should not be updated until reverseqc is successful (ie. return is picked)

@sumit5219, please resubmit logs for Flow 1 and Flow 6

sandeepshahi commented 3 months ago

Hi @sandeepshahi , Below is the video demo for incremental search.

backend service logs which sends in every one minute

Merchant app updating products price, as soon the update is done in next a minute the on_search is send.

https://drive.google.com/drive/folders/19lxGO_xjLfkoImF7TrpORqIL2l2OELsx?usp=sharing

Sure, will check this

sumit5219 commented 3 months ago

Hi @sandeepshahi , above mentioned issues are fixed please find the PR - https://github.com/ONDC-Official/v1.2.0-logs/pull/1644 Note: As from ondc buyer app no incremental req are coming to us atleast so we have used our buyer app to subscribe to push search subscription.

Flow 6 - order screenshot

sandeepshahi commented 3 months ago

Flow 2

/on_status

tracking url (fulfillments/tags/tracking) seems invalid; invoice is sent instead of tracking info; also, the invoice consists of part cancelled item
the delivery charges are marked as "0" in the invoice (/order/documents/url) whereas the actual price is Rs 30.

Flow 6

/on_update (Return Approved)

return pickup range should be realistic; pickup within 5 minutes may not be possible

@sumit5219

ONDC-Official / v1.2.0-logs