0% found this document useful (0 votes)
85 views34 pages

DLV Store Integration Document

Uploaded by

Anuj Singhal
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
85 views34 pages

DLV Store Integration Document

Uploaded by

Anuj Singhal
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 34

DLV STORE INTEGRATION DOCUMENT

Version Date Description Author

0.1 10 Feb 23 Draft Version (Integration flow added) Eshant Shrivas

0.2 30 Mar 23 Added staging account details Eshant Shrivas

0.3 31 Mar 23 Added Product Create Callback payload Eshant Shrivas

Account Details

Configuration Staging Production

Client Name DELHIVERY STORE DEL North Store


INTEGRATION

Client UUID af8f09efa7954990a14a5cee411f 9f204ff60d844c63be46b96ab33


8521 5ceb3

FC Name FCDEL1, FCDEL10, TESTFC, NORTH STORE,


DivsFC Bangalore_Koralur_S,
Bhiwandi_Vadpe_S,
Kolkata_EastVRTL_S

Channel Name store store

Channel UUID ee458162868d4b8aa525f3ff47d 2e6c341b02b14ff7bd3f852c9c


46ba3 6ba07d

username store_user storeuser1

password Wel******** Wel********

Prime Buckets To be discussed Fresh, Used

Reject Buckets To be discussed Reject

Orcale/Rezo<>WMS Touchpoints

Head Touchpoint Source Destination Flow Phase Description

Inbound AGN Create Client WMS Client >> WMS ASN would be
posted to WMS

AGN Create Client WMS Client >> WMS


Callback

Inbound WMS Client WMS >> Client To notify the


Completed client for the
Notification respective batch
inbound
completion
(putaway) for
the SKUs with
the received qty

Outbound Order Create Client WMS Client >> WMS Order would be
pushed to the
WMS via API

Order Create WMS Client WMS >> Client


Callback

Order WMS Client WMS >> Client Order Allocated


Allocated notification is
Notification sent to the client
for order getting
allocated.

Pack Initiate WMS Client WMS >> Client


Call

Invoice Upload Client WMS Client >> WMS

Order Packed WMS Client WMS >> Client The client is


notification notified for the
order packed
with respective
serial numbers
via Pack Waybill
notification

Shipped/ WMS Client WMS >> Client After the order


Dispatch is shipped, the
Complete Dispatch
Notification Complete
notification
notifies the
client for the
same.

ILN Inventory Level WMS Client WMS >> Client Inventory


Notification snapshot to be
sent to the client
as per client
requirement at
the time interval
configured via
cron job.
Delhivery Authentication
To access any of Delhivery's APIs, the authenticate API is used which generates a bearer token.
This token is used in the Authorization header of all other APIs. The key fields and the curl in
the subsequent subsections can be referred for Authenticate API touchpoint for Non-production
environment.

Method - POST
Non-production URL Endpoint -
https://staging-phuze.pntrzz.com/api/v1/auth/user/authenticate
API Curl - The API Curl is as follows:

curl --location 'https://staging-phuze.pntrzz.com/api/v1/auth/user/authenticate' \


--header 'Content-Type: application/json' \
--data-raw '{
"password":"Welcome@123",
"username":"store_user"
}'

API Response - Sample succes response is as follow:


{
"success": true,
"errors": [],
"message": "Login successful",
"_metadata": {},
"data": {
"access_token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2Nzk1NTY3MDQsImlhdCI6MTY3ODY
5MjcwNCwibmJmIjoxNjc4NjkyNzA0LCJpZGVudGl0eSI6Imtpc2FuNHVfdXNlciJ9.H2oi7xHTyQH
sBrAbTy43o7Z188oDLeA8Z8nvN-g_nzs"
}
}

NOTE: The authentication token has the validity of 24 hrs after which a new token to be fetched
using the Authenticate API. Also, it is recommended to develop the logic that for 401 error, a
new token to be fetched using the API curl.
Inbound Workflow
The high level Inbound integration workflow is depicted as follows:

1. Product Create API

curl --location 'https://staging-phuze.pntrzz.com/generic/v1/product/create' \


--header 'Authorization: Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2ODEwMjk1MjAsImlhdCI6MTY4MDE2
NTUyMCwibmJmIjoxNjgwMTY1NTIwLCJpZGVudGl0eSI6InN0b3JlX3VzZXIifQ.w-Jmq4DY1mjY
NfYI-4rUZEcFWYdcy-ykMS3sbve4O2A' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"sku": "test002",
"name": "test002",
"scannable_id": "test002",
"description": "test002",
"hsn_code": "",
"category": "110",
"length": 87.000,
"width": 41.000,
"height": 94.000,
"billing_category": "1",
"mrp": 0.00,
"lot_configuration": {
"control_params": [
{
"name": "external_bucket",
"label": "External Bucket",
"type": "red"
}
]
}
},
"client_uuid": "af8f09efa7954990a14a5cee411f8521"
}'

2. Product Create Callback


Generic Product Create Callback (Success)
{
"client_uuid":"af8f09efa7954990a14a5cee411f8521",
"product_sku":"resku4",
"product_name":"Test Product",
"status":"Success",
"status_code":"200",
"error_message":"",
"activity":"PRODUCT_CREATE_CALLBACK",
"extras":{
}
}

Generic Product Create Callback (Failed)


{
"client_uuid":"af8f09efa7954990a14a5cee411f8521",
"product_sku":"resku5",
"product_name":"Test Product",
"status":"Failed",
"status_code":"400",
"error_message":"Invalid request. Please check error",
"activity":"PRODUCT_CREATE_CALLBACK",
"extras":{
}
}

3. AGN Create API


The bulk AGN can be pushed to WMS using the Bulk AGN Create API. The following curl can
be referred for AGN Create API touchpoint for the non-production environment.

curl --location --request POST 'https://staging-phuze.pntrzz.com/generic/v1/agn/create-bulk' \


--header 'Content-Type: application/json' \
--header 'Authorization: Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NjkzMTQ3NzgsImlhdCI6MTY2ODQ1
MDc3OCwibmJmIjoxNjY4NDUwNzc4LCJpZGVudGl0eSI6InBheXRtIn0.IuYjP8kAU4huB0PgRH
MRx_frLoRzX41RN5uCr6YI8nY' \
--data-raw '{
"data": [
{
"source_number": "paytm_test009",
"agn_type": "FWD", (COR/CUR)
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"expected_arrival_date": "2022-11-21 11:07:52.503000+00:00",
"expiry_date": "2022-11-25 11:07:52.503000+00:00",
"client_extras": {},
"fulfillment_center_uuid": "1547ae7b4b384408b3bd5dcec43b8193",
"mode_of_transport": "DF",
"products": [
{
"quantity": 2,
"sku": "paytm_test05",
}
]
}
]
}
]
}'

4. AGN Create Callback


AGN create callback will be triggered to client endpoint once it is created in WMS. In case of
any failure Paytm to re-trigger the respective AGN requests with changes if any.
{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"source_number": "paytm_test011",
"status": "Success",
"status_code": "200",
"error_message": " “,
"activity": "ASN_CREATE_CALLBACK"
}

AGN Fail Callback:


{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"source_number": "paytm_test90000900",
"status": "Failed",
"status_code": "400",
"error_message": "Few Products are not valid in requested products“,
"activity": "ASN_CREATE_CALLBACK",
"errors": [
{
"error_message": "Few Products are not valid in requested products",
"error_code": "WMS-AGN:ProductValidationFailed"
}
],
"extras": {

}
}

5. Inbound Completed Notification


The Inbound Complete notification sent by the WMS will have all the SKUs with their respective
putaway quantity, buckets and serial number info. Below is the sample Inbound Complete
payload notification as per the current implementation of WMS.

{
"source_number": "Ordermax119",
"batch_number": "BATCH-20230111-22712",
"batch_id": "22712",
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"facility": "FCDEL1",
"activity": "INBOUND_COMPLETE",
"agn_type": "FWD",
"receiving_time": "Wed Jan 11 13:07:43 IST 2023",
"products": [
{
"sku": "100024",
"name": "Airtel_1GB_40",
"received_qty": 500,
"stocked_qty": 500,
"total_qty": 500,
"uom_received_qty": 500.0,
"uom_stocked_qty": 500.0,
"uom_total_qty": 500.0,
"lot_data": [
{
"qty": 100,
"uom_qty": 100.0,
"lot_id": "2CZrT4UBDUw-tp9jliOO",
"internal_bucket": "REJECT",
"external_bucket": "To_Be_Scrapped",
"lot_params": {
"external_bucket": "To_Be_Scrapped"
},
"serial_numbers": [
"6180300000000108",
"6180300000000107",
"6180300000000009"
]
},
{
"qty": 50,
"uom_qty": 50.0,
"lot_id": "eSYNWIUBDUw-tp9j2icL",
"internal_bucket": "REJECT",
"external_bucket": "Returned_IW",
"lot_params": {
"external_bucket": "Returned_IW"
},
"serial_numbers": [
"3180320112218548",
"3180320112218499"
]
},
{
"qty": 50,
"uom_qty": 50.0,
"lot_id": "qyZbWIUBDUw-tp9jQic9",
"internal_bucket": "REJECT",
"external_bucket": "QC_Rejected",
"lot_params": {
"external_bucket": "QC_Rejected"
},
"serial_numbers": [
"1000320000018448",
"1000320000018399"
]
},
{
"qty": 100,
"uom_qty": 100.0,
"lot_id": "CybeOIUBDUw-tp9jFyJk",
"internal_bucket": "PRIME",
"external_bucket": "New",
"lot_params": {
"external_bucket": "New"
},
"serial_numbers": [
"1180320112218099"
]
},
{
"qty": 100,
"uom_qty": 100.0,
"lot_id": "LCZ9NIUBDUw-tp9jOiFI",
"internal_bucket": "PRIME",
"external_bucket": "Refurbished_Q1",
"lot_params": {
"external_bucket": "Refurbished_Q1"
},
"serial_numbers": [
"2180320112218220"
]
},
{
"qty": 100,
"uom_qty": 100.0,
"lot_id": "iyZFhoUBDUw-tp9jI2QK",
"internal_bucket": "PRIME",
"external_bucket": "Repaired",
"lot_params": {
"external_bucket": "Repaired"
},
"serial_numbers": [
"1000320112218386"
]
}
],
"extras": {

}
}
],
"extras": {
"e-waybill": "NA",
"lr_num": "LR0987",
"invoice_number": "INV09876"
}
}

Inbound Completed Response


Expected Sample success response:
{
"status": "SUCCESS",
“message": "Notification received",
"status_code": 200
}

Inventory Level Notification

Below is the sample payload.

{
"facility":"BADARPUR_TEST",
"client_uuid":"3446b92538e2401d8b232227eed5c1f2",
"activity":"INVENTORY_PICTURE_V2",
"s3_url":" "
}

S3 file payload:
{
"fulfillment_center": "ROUTECHFC1",
"client_uuid": "580451f6a57e43018da0bda366b74bd2",
"products": [
{
"product_sku": "phuze_Test1",
"count": 11,
"lot_params": [
{
"lot_id": "V0V0B38BlUa1GgYITwfi",
"client_id": "580451f6a57e43018da0bda366b74bd2",
"lotExpired": false,
"lotShortExpired": false,
"count": 1,
"bucket": "PRIME"
},
{
"lot_id": "ykW8On8BlUa1GgYIig7j",
"client_id": "580451f6a57e43018da0bda366b74bd2",
"lotExpired": false,
"lotShortExpired": false,
"count": 10,
"bucket": "VENDOR_DAMAGE"
}
]
}
]
}

ILN Response
Expected Sample success response:
{
"status": "SUCCESS",
“message": "Notification received",
"status_code": 200
}
Outbound Workflow
The high level Inbound integration workflow is depicted as follows:
1. Order Create API
The order can be pushed to WMS using the Order Create API. The following curl can be
referred for the Order Create API touchpoint for non production environment.

curl --location --request POST 'https://staging-phuze.pntrzz.com/generic/v1/order/create-bulk' \


--header 'Authorization: Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2Njk4MDY4NjQsImlhdCI6MTY2ODk0Mj
g2NCwibmJmIjoxNjY4OTQyODY0LCJpZGVudGl0eSI6InBheXRtIn0._8-sKRRc-ywsgUPxrRKBq
T2UkWIRA5bynb2_YRPQ0LY' \
--header 'client-uuid: bef6e668923a42f9a69ef616be3ab0ae' \
--header 'Content-Type: application/json' \
--data-raw '{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"data": {
"data": {
"orders": [
{
"channel": "store",
"consignee": {
"address_line1": "plot 5",
"address_line2": "sector 44",
"city": "gurgaon",
"country": "India",
"name": "Test",
"pin_code": 122001,
"primary_phone_number": "9599483571",
"secondary_phone_number": "",
"state": "Haryana"
},
"order_date": "2022-01-02 17:20:00.000000",
"order_number": "paytm2111_O3",
"order_type": "FWD",
"shipments": [
{
"fc": "FCDEL1",
"child_courier": "DELHIVERY EXPRESS",
"dispatch_after_date": "2022-11-23 00:00:00.000000",
"priority": "P1",
"invoice": {
"payment_mode": "PREPAID"
},
"number": "paytm2111_O3",
"is_hold": "false",
"order_lines": [
{
"bucket": "PRIME",
"client_id": "bef6e668923a42f9a69ef616be3ab0ae",
"invoice": {
"payment_mode": "PREPAID"
},
"number": "OL1",
"product_sku": "paytm_test05",
"quantity": 1,
"lot_value": {
"external_bucket": "PRIME"
}
},
{
"bucket": "PRIME",
"client_id": "bef6e668923a42f9a69ef616be3ab0ae",
"invoice": {
"payment_mode": "PREPAID"
},
"number": "OL2",
"product_sku": "paytm_test06",
"quantity": 1,
"lot_value": {
"external_bucket": "PRIME"
}
}

],
"ship_by_date": "",
"waybill": ""
}
],
"sub_order_type": ""
},
{
"channel": "paytm",
"consignee": {
"address_line1": "plot 5",
"address_line2": "sector 44",
"city": "gurgaon",
"country": "India",
"name": "Test",
"pin_code": 122001,
"primary_phone_number": "9599483571",
"secondary_phone_number": "",
"state": "Haryana"
},
"order_date": "2022-01-02 17:20:00.000000",
"order_number": "paytm2111_O4",
"order_type": "FWD", ,
"shipments": [
{
"fc": "FCDEL1",
"child_courier": "DELHIVERY EXPRESS",
"dispatch_after_date": "2022-11-22 00:00:00.000000",
"priority": "P2",
"invoice": {
"payment_mode": "PREPAID"
},
"number": "paytm2111_O2",
"is_hold": "true",
"order_lines": [
{
"bucket": "PRIME",
"client_id": "bef6e668923a42f9a69ef616be3ab0ae",
"invoice": {
"payment_mode": "PREPAID"
},
"number": "OL1",
"product_sku": "paytm_test05",
"quantity": 1,
"lot_value": {
"external_bucket": "PRIME"
}
},
{
"bucket": "PRIME",
"client_id": "bef6e668923a42f9a69ef616be3ab0ae",
"invoice": {
"payment_mode": "PREPAID"
},
"number": "OL2",
"product_sku": "paytm_test06",
"quantity": 1,
"lot_value": {
"external_bucket": "PRIME"
}
}
],
"ship_by_date": "",
"waybill": ""
}
],
"sub_order_type": ""
}
]
}
}
}'

2. Order Create Response/Callback


Order create callback will be triggered to the client endpoint once it is created in WMS. In case
of any failure Paytm to re-trigger the respective AGN requests with changes if any.

{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"order_number": "paytm2211_04",
"status": "Success",
"status_code": "200",
"error_message": "",
"error_code": "",
"activity": "OMS_ORDER_CREATED"
}

3. Order Allocated Notification


Below is the sample payload.

{
"orders": [
{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"client_store_name": "paytm",
"order_number": "paytm2111_O5",
"fulfillment_center": "FCDEL1",
"activity": "ORDER_ALLOCATED",
"shipments": [
{
"shipment_number": "paytm2111_O5",
"shipment_id": 12475,
"updated_at": "Mon Nov 21 23:28:21 IST 2022",
"created_at": "Sun Jan 02 22:50:00 IST 2022",
"ship_by_date": "Tue Nov 22 23:28:21 IST 2022",
"rts_at": "Mon Nov 21 23:28:21 IST 2022",
"status": "ALC",
"extras": {

},
"order_lines": [
{
"order_line_number": "OL1",
"product_sku": "paytm_test05",
"product_name": "paytm_test05",
"total_qty": 1,
"uom_total_qty": 1.0,
"qty": 1,
"uom_qty": 1.0,
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iiVulYQBDUw-tp9jkPli",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {

},
"wms_invoice": {
"invoice_id": 28932,
"payment_mode": "PREPAID",
"total_price": 0.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 0.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0,
"tan_number": "1",
"vat_number": "1",
"cst_number": "1",
"service_tax_number": "1",
"cin_number": "1",
"gstin_number": "1"
}
},
{
"order_line_number": "OL2",
"product_sku": "paytm_test06",
"product_name": "paytm_test06",
"total_qty": 1,
"uom_total_qty": 1.0,
"qty": 1,
"uom_qty": 1.0,
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iyVwlYQBDUw-tp9j0_lX",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {

},
"wms_invoice": {
"invoice_id": 28933,
"payment_mode": "PREPAID",
"total_price": 0.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 0.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0,
"tan_number": "1",
"vat_number": "1",
"cst_number": "1",
"service_tax_number": "1",
"cin_number": "1",
"gstin_number": "1"
}
}
],
"courier": "DELHIVERY EXPRESS",
"invoice_detail": {
"invoice_id": 28931,
"payment_mode": "PREPAID",
"total_price": 0.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 0.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0
}
}
],
"extras": {

},
"consignee_details": {
"name": "Test",
"address_line1": "plot 5",
"address_line2": "sector 44",
"pin_code": 122001,
"city": "gurgaon",
"state": "Haryana",
"country": "India",
"primary_phone_number": "9599483571",
"secondary_phone_number": ""
}
}
]
}

4. Pack Initiate Call


Below is the sample payload.

{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"order_number": "paytm2111_O2",
"fulfillment_center": "FCDEL1",
"activity": "PACK_INITIATE",
"shipment_number": "paytm2111_O2",
"updated_at": "Mon Nov 21 23:01:16 IST 2022",
"products": [
{
"prod_sku": "paytm_test05",
"order_line_number": "OL1",
"prod_qty": "1",
"uom_prod_qty": 1.00,
"serial_numbers": [
"8769831523076008"
],
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iiVulYQBDUw-tp9jkPli",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {

}
},
{
"prod_sku": "paytm_test06",
"order_line_number": "OL2",
"prod_qty": "1",
"uom_prod_qty": 1.00,
"serial_numbers": [
"8769831523076008"
],
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iyVwlYQBDUw-tp9j0_lX",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {

}
}
]
}

Pack Initiate Call Response


Expected Sample success response:
{
"status": "SUCCESS",
“message": "Notification received",
"status_code": 200
}

5. Invoice Upload API


Below is the sample working curl.

curl --location --request PUT 'https://staging-phuze.pntrzz.com/generic/v1/invoice/update' \


--header 'Authorization: Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2Njk4MDY4NjQsImlhdCI6MTY2ODk0Mj
g2NCwibmJmIjoxNjY4OTQyODY0LCJpZGVudGl0eSI6InBheXRtIn0._8-sKRRc-ywsgUPxrRKBq
T2UkWIRA5bynb2_YRPQ0LY' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {
"cod_amount": 0,
"invoice_date": "2022-11-20 17:20:00.000000", [Mandatory]
"invoice_number": "IN114795812", [Mandatory]
"invoice_pdf": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
[Mandatory]
"invoice_value": "1900", [Mandatory]
"net_amount": 1900,
"order_number": "paytm2011", [Mandatory]
"payment_mode": "PREPAID",
"shipment_number": "paytm2011", [Mandatory]
"total_amt": "1900", [Mandatory]
"total_price": 1900
}
}'

6. Pack Waybill Notification


Below is the sample payload..

{
"orders": [
{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"client_store_name": "paytm",
"order_number": "paytm2011",
"fulfillment_center": "FCDEL1",
"activity": "PACK_WAYBILL",
"shipments": [
{
"shipment_number": "paytm2011",
"shipment_id": 12456,
"updated_at": "Sun Nov 20 21:37:34 IST 2022",
"created_at": "Sun Jan 02 22:50:00 IST 2022",
"ship_by_date": "Mon Nov 21 21:26:11 IST 2022",
"rts_at": "Sun Nov 20 21:37:34 IST 2022",
"status": "PAK",
"extras": {

},
"order_lines": [
{
"order_line_number": "OL1",
"product_sku": "paytm_test05",
"product_name": "paytm_test05",
"total_qty": 1,
"uom_total_qty": 1.0,
"qty": 1,
"uom_qty": 1.0,
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iiVulYQBDUw-tp9jkPli",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {

},
"wms_invoice": {
"invoice_id": 28852,
"payment_mode": "PREPAID",
"total_price": 0.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 0.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0,
"tan_number": "1",
"vat_number": "1",
"cst_number": "1",
"service_tax_number": "1",
"cin_number": "1",
"gstin_number": "1"
},
"waybill": {
"mawb_flag": true,
"mawb_number": "1394410234312",
"awb_count": 1,
"waybill_number": [
{
"awb_number": "1394410234312",
"qty": 1,
"uom_qty": 1.0,
"box_id": "12456-1668960340218-1",
"secondary_serials": [
{
"IMEI": "8769831523076001",
"SN": "8769831523076001"
}
]
}
],
"courier_name": "DELHIVERY",
"quantity": 1,
"uom_quantity": 1.0
}
},
{
"order_line_number": "OL2",
"product_sku": "paytm_test06",
"product_name": "paytm_test06",
"total_qty": 1,
"uom_total_qty": 1.0,
"qty": 1,
"uom_qty": 1.0,
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iyVwlYQBDUw-tp9j0_lX",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {

},
"wms_invoice": {
"invoice_id": 28853,
"payment_mode": "PREPAID",
"total_price": 0.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 0.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0,
"tan_number": "1",
"vat_number": "1",
"cst_number": "1",
"service_tax_number": "1",
"cin_number": "1",
"gstin_number": "1"
},
"waybill": {
"mawb_flag": true,
"mawb_number": "1394410234312",
"awb_count": 1,
"waybill_number": [
{
"awb_number": "1394410234312",
"qty": 1,
"uom_qty": 1.0,
"box_id": "12456-1668960340218-1",
"secondary_serials": [
{
"IMEI": "8769831523077001",
"SN": "8769831523077001"
}
]
}
],
"courier_name": "DELHIVERY",
"quantity": 1,
"uom_quantity": 1.0
}
}
],
"courier": "DELHIVERY EXPRESS",
"invoice_detail": {
"invoice_id": 28851,
"invoice_number": "IN114795812",
"payment_mode": "PREPAID",
"total_price": 1900.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 1900.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0
}
}
],
"extras": {

},
"consignee_details": {
"name": "Test",
"address_line1": "plot 5",
"address_line2": "sector 44",
"pin_code": 122001,
"city": "gurgaon",
"state": "Haryana",
"country": "India",
"primary_phone_number": "9599483571",
"secondary_phone_number": ""
}
}
]
}

Pack Waybill Notification Response


Expected Sample success response:
{
"status": "SUCCESS",
“message": "Notification received",
"status_code": 200
}
7. Order Shipped Notification
Below is the sample payload.
{
"orders": [
{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"client_store_name": "paytm",
"order_number": "paytm2011",
"fulfillment_center": "FCDEL1",
"activity": "DISPATCH_COMPLETE",
"shipments": [
{
"shipment_number": "paytm2011",
"shipment_id": 12456,
"updated_at": "Sun Nov 20 21:48:06 IST 2022",
"created_at": "Sun Jan 02 22:50:00 IST 2022",
"ship_by_date": "Mon Nov 21 21:26:11 IST 2022",
"rts_at": "Sun Nov 20 21:48:06 IST 2022",
"status": "SHP",
"transportation_entities":
{
"e-waybill": "29AAACG0569P1Z3"
},
"extras": {

},
"order_lines": [
{
"order_line_number": "OL1",
"product_sku": "paytm_test05",
"product_name": "paytm_test05",
"total_qty": 1,
"uom_total_qty": 1.0,
"qty": 1,
"uom_qty": 1.0,
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iiVulYQBDUw-tp9jkPli",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {
},
"wms_invoice": {
"invoice_id": 28852,
"payment_mode": "PREPAID",
"total_price": 0.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 0.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0,
"tan_number": "1",
"vat_number": "1",
"cst_number": "1",
"service_tax_number": "1",
"cin_number": "1",
"gstin_number": "1"
},
"waybill": {
"mawb_flag": true,
"mawb_number": "1394410234312",
"awb_count": 1,
"waybill_number": [
{
"awb_number": "1394410234312",
"dispatch_number": "DSP/FCDEL1/20221120/161742760286",
"dimension_unit": "cm",
"weight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"qty": 1,
"uom_qty": 1.0,
"box_id": "12456-1668960340218-1",
"secondary_serials": [
{
"IMEI": "8769831523076001",
"SN": "8769831523076001"
}
]
}
],
"courier_name": "DELHIVERY",
"quantity": 1,
"uom_quantity": 1.0
}
},
{
"order_line_number": "OL2",
"product_sku": "paytm_test06",
"product_name": "paytm_test06",
"total_qty": 1,
"uom_total_qty": 1.0,
"qty": 1,
"uom_qty": 1.0,
"lot_value": [
{
"external_bucket": "PRIME",
"lot_id": "iyVwlYQBDUw-tp9j0_lX",
"uom_qty": "1.0",
"qty": "1"
}
],
"extras": {

},
"wms_invoice": {
"invoice_id": 28853,
"payment_mode": "PREPAID",
"total_price": 0.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 0.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0,
"tan_number": "1",
"vat_number": "1",
"cst_number": "1",
"service_tax_number": "1",
"cin_number": "1",
"gstin_number": "1"
},
"waybill": {
"mawb_flag": true,
"mawb_number": "1394410234312",
"awb_count": 1,
"waybill_number": [
{
"awb_number": "1394410234312",
"dispatch_number": "DSP/FCDEL1/20221120/161742760286",
"dimension_unit": "cm",
"weight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"qty": 1,
"uom_qty": 1.0,
"box_id": "12456-1668960340218-1",
"secondary_serials": [
{
"IMEI": "8769831523077001",
"SN": "8769831523077001"
}
]
}
],
"courier_name": "DELHIVERY",
"quantity": 1,
"uom_quantity": 1.0
}
}
],
"parent_courier": "DELHIVERY",
"courier": "DELHIVERY EXPRESS",
"invoice_detail": {
"invoice_id": 28851,
"invoice_number": "IN114795812",
"payment_mode": "PREPAID",
"total_price": 1900.0,
"cod_amount": 0.0,
"unit_price": 0.0,
"unit_taxes": 0.0,
"total_cst": 0.0,
"total_vat": 0.0,
"total_taxes": 0.0,
"shipping_price": 0.0,
"gross_value": 0.0,
"discount": 0.0,
"vat_percentage": 0.0,
"cst_percentage": 0.0,
"tax_percentage": 0.0,
"net_amount": 1900.0,
"advance_payment": 0.0,
"round_off": 0.0,
"mrp": 0.0,
"cgst_percentage": 0.0,
"cgst_amount": 0.0,
"sgst_percentage": 0.0,
"sgst_amount": 0.0,
"igst_percentage": 0.0,
"igst_amount": 0.0
}
}
],
"extras": {

},
"consignee_details": {
"name": "Test",
"address_line1": "plot 5",
"address_line2": "sector 44",
"pin_code": 122001,
"city": "gurgaon",
"state": "Haryana",
"country": "India",
"primary_phone_number": "9599483571",
"secondary_phone_number": ""
}
}
]
}

Shipped Notiifcation Response


Expected Sample success response:
{
"status": "SUCCESS",
“message": "Notification received",
"status_code": 200
}

You might also like