DLV Store Integration Document
DLV Store Integration Document
Account Details
Orcale/Rezo<>WMS Touchpoints
Inbound AGN Create Client WMS Client >> WMS ASN would be
posted to WMS
Outbound Order Create Client WMS Client >> WMS Order would be
pushed to the
WMS via API
Method - POST
Non-production URL Endpoint -
https://staging-phuze.pntrzz.com/api/v1/auth/user/authenticate
API Curl - The API Curl is as follows:
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:
}
}
{
"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"
}
}
{
"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.
],
"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": ""
}
]
}
}
}'
{
"client_uuid": "bef6e668923a42f9a69ef616be3ab0ae",
"order_number": "paytm2211_04",
"status": "Success",
"status_code": "200",
"error_message": "",
"error_code": "",
"activity": "OMS_ORDER_CREATED"
}
{
"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": ""
}
}
]
}
{
"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": {
}
}
]
}
{
"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": ""
}
}
]
}
},
"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": ""
}
}
]
}