Scribd
Upload
5 views19 pages

Integration API's

The document outlines various APIs for order management, including creating, tracking, canceling orders, and fetching operational cities and locations. Each API includes specific URLs, required headers, request bodies, and sample responses. The APIs facilitate functionalities like order creation, tracking order history, and retrieving payment status for merchants using the service.

Uploaded by

shahabranaw
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
5 views19 pages

Integration API's

The document outlines various APIs for order management, including creating, tracking, canceling orders, and fetching operational cities and locations. Each API includes specific URLs, required headers, request bodies, and sample responses. The APIs facilitate functionalities like order creation, tracking order history, and retrieving payment status for merchants using the service.

Uploaded by

shahabranaw
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

Authen'ca'on Token: 09f4924c715a474385938f7fef946e04

API’s
Create Order (CN Fulfillment) (Post API)
This API is for crea9ng an order. The required header and values are men9oned. And in response, you
will get a tracking number for the created order or status in case of any error.

URL: hJps://[Link]/api/custom/v1/create-order/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Payload (Request Body) with dummy data:

"reference_number": "ORD001",

"order_details": "Sample order details",

"customer_name": "John Doe",

"customer_phone": "03001234567",

"special_instruc9ons": "Handle with care",

"pickup_address_code": "TMLO",

"return_address_code": "TMLO",

"des9na9on_city": "Lahore",

"delivery_address": "123 Main Street, Gulberg",

"ds_shipment_type": 1, // 1 for Regular and 2 for Detain

"store_id": 1

"cod_amount": 100,

"total_items": 1,

"booking_weight": 1.5

"customer_email": “john@[Link]”

}
Sample Response: -
{

"tracking_number": "T0000101184542952"

Track Order (Tracking API) (Get API)


This API is for tracking an order. The required header and values are men9oned. Mul9ple orders can be
tracked at the same 9me.

URL: hJps://[Link]/api/custom/v1/track-order/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

Header Key: tracking_numbers

Header Value: ["T0000156448681357", "T0000135816215045"]

Sample Response: -
{

"reference_number": "ORD001",

"tracking_number": "0002116516825345",

"booking_amount": 50.0,

"order_details": "Sample order details",

"total_items": 1,

"booking_weight": 1.5,

"actual_weight": 0.0,

"customer_name": "John Doe",

"customer_phone": "03001234567",

"customer_email": "john@[Link]",

"pickup_loca9on": "LOC123",
"return_loca9on": "LOC123",

"des9na9on_city": "Lahore",

"delivery_address": "123 Main Street, Gulberg",

"special_instruc9ons": "Handle with care",

"ds_shipment_type": "Regular",

"merchant_store": "new new abc",

"order_status": "Cancelled",

"delivery_fee": 0.0,

"delivery_tax": 0.0,

"delivery_fuel_fee": 0.0,

"cash_handling_fee": 0.0,

"return_ini9ated": 0,

"advice_ini9ated": 0

Track Order History (Journey API) (Get API)


This API is for tracking complete journey of an order. The required header and values are men9oned.
Mul9ple orders can be tracked at the same 9me.

URL: hJps://[Link]/api/custom/v1/track-order-history/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

Header Key: tracking_numbers

Header Value: ["T0000106718558345","T0000169688183864"]

Sample Response: -
"T0000198027999914": [

{
"order_status_code": "1009",

"order_status": "Delivered",

"order_status_message": "Delivered to the Customer at Test Address Johar Town",

"status_date_9me": "2025-09-24T22:20:18.453162",

"aJempt_proof_url": null

},

"order_status_code": "1007",

"order_status": "Delivery In-Process",

"order_status_message": "Tranzo will aJempt to deliver shipment today at Test Address Johar
Town",

"status_date_9me": "2025-09-24T22:10:37.582438",

"aJempt_proof_url": null

},

"order_status_code": "1005",

"order_status": "Shipper Warehouse",

"order_status_message": "Shipment arrived at Tranzo logis9c facility.",

"status_date_9me": "2025-09-24T22:06:11.504221",

"aJempt_proof_url": null

},

"order_status_code": "1004",

"order_status": "Shipment Picked",

"order_status_message": "Shipment picked by Tranzo from Vogue Tower Gulberg 3,",

"status_date_9me": "2025-09-24T22:05:40.659291",

"aJempt_proof_url": null

},

{
"order_status_code": "1003",

"order_status": "Pickup Sheet Generated",

"order_status_message": "Ready to ship to Tranzo",

"status_date_9me": "2025-09-24T22:05:03.647899",

"aJempt_proof_url": null

},

"order_status_code": "1001",

"order_status": "Order Created",

"order_status_message": "Salman placed order on Test M1 Store One",

"status_date_9me": "2025-09-24T22:04:40.098704",

"aJempt_proof_url": null

Cancel Order (Cancel Fulfilment) (Put API)


This API is to mark an order(s) canceled. The required header and values are men9oned. Mul9ple orders
can be cancelled simultaneously. Upon success or failure, a status code will be returned.

URL: hJps://[Link]/api/custom/v1/cancel-order/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Request Body: -

"tracking_numbers": ["T0000184817418609", "T0000152002622700"]

Sample Response: -
{

"tracking_number": "T0000158879461287",

"status_code": 200,

"message": "Order cancelled successfully."

OperaAonal CiAes (Get API)


This API is for fetching opera9onal ci9es of Tranzo. The required header and values are men9oned.

URL: hJps://[Link]/api/custom/v1/get-opera9onal-ci9es/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Sample Response: -
{

"id": 117,

"city_name": "Lahore",

"is_pickup_allowed": true,

"is_delivery_allowed": true,

"is_return_allowed": true

},
All LocaAons (Get API)
This API is for fetching all Loca9ons of a Merchant. The required header and values are men9oned.

URL: hJps://[Link]/api/custom/v1/get-loca9ons/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Sample Response: -
{

"id": 103,

"loca9on_9tle": "Faisalabad (022)",

"loca9on_code": "FSDd",

"contact_person_phone_1": "+923064425680",

"contact_person_phone_2": "+923247787668",

"city": "Faisalabad",

"contact_person_name": "Kaleem juJ",

"contact_person_email": "test@[Link]",

"loca9on_address": "FSD Address New test",

"merchant": "New User",

"is_pickup": true,

"is_return": true,

"is_ac9ve": true,

"created_by": "User New",

"created_at": "2025-11-22T20:13:49.014380",

"merchant_id": 21

},
All Stores (Get API)
This API is for fetching all stores of a Merchant. The required header and values are men9oned.

URL: hJps://[Link]/api/custom/v1/get-stores/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Sample Response: -
{

"store_name": "Gulberg",

"store_id": 27,

"city": "Lahore"

},

All Shipment Types (Get API)


This API is for fetching all shipments allowed to Merchant. The required header and values are
men9oned.

URL: hJps://[Link]/api/custom/v1/get-shipment-types/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Sample Response: -
{

"id": 1,

"ds_shipment_type": "Regular"

},

{
"id": 2,

"ds_shipment_type": "Detain"

Order Logs (Get API)


This API is to get all orders with specific status or within date range. The required header and values are
men9oned.

URL: hJps://[Link]/api/custom/v1/get-order-logs/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

"tracking_numbers": ["T0000139737418097", "T0000190748971295"]

Or

“order_status_code”: 1002

Or

“date_from”: 2025-05-12

“date_to”: 2025-05-15

Sample Response: -
{

"reference_number": "ORD001",

"tracking_number": "0002192035078376",

"booking_amount": 50.0,

"order_details": "Sample order details",

"total_items": 1,

"booking_weight": 1.5,

"actual_weight": 0.0,
"customer_name": "John Doe",

"customer_phone": "03001234567",

"customer_email": "john@[Link]",

"pickup_loca'on": "LOC123",

"return_loca'on": "LOC123",

"des'na'on_city": "Lahore",

"delivery_address": "123 Main Street, Gulberg",

"special_instruc'ons": "Handle with care",

"ds_shipment_type": "Regular",

"merchant_store": "new new abc",

"order_status": "Cancelled",

"delivery_fee": 0.0,

"delivery_tax": 0.0,

"delivery_fuel_fee": 0.0,

"cash_handling_fee": 0.0,

"return_ini'ated": 0,

"advice_ini'ated": 0

},

Pending Merchant Advice Orders (Get API)


This API is to get all orders which require merchant advice within date range. The required header and
values are men9oned.

URL: hJps://[Link]/api/custom/v1/pending-merchant-advice/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

“date_from”: 2025-05-12

“date_to”: 2025-05-15
}

Sample Response: -
{

"tracking_number": "T0000120394564166",

"reference_number": "ORD100284",

"advice_required_since": "2025-12-23 23:45:00"

},

Shipper Advice (Put API)


This API is to post advice on the shipper advice orders. order_status “R” is to mark Request for Return
and “A” is to mark Request for ReAJempt.

URL: hJps://[Link]/api/custom/v1/create-merchant-advice/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Body: -

"orders": [

// {

// "tracking_number": "",

// "order_status": "R",

// "remarks": "Customer requested return"

// },

"tracking_number": "T0002119302037627",

"order_status": "A", / / Pass “R” to Request for Return and “A” for Request to Reahempt.

"remarks": "Customer not available, need re-ahempt"

]
}

All Order Statuses (Get API)


This API is for fetching all order statuses. The required header and values are men9oned.

URL: hJps://[Link]/api/custom/v1/get-order-status/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Sample Response: -
{

"order_status": "Order Created",

"order_status_code": "1001"

},

"order_status": "Cancelled",

"order_status_code": "1002"

},

Create Location (Post API)


This API is for creating a location. The required header and values are mentioned.

URL: [Link]
Request Headers: -
Header Key: api-token
Header Value: 09f4924c715a474385938f7fef946e04
Body:
{

"loca'on_'tle": "Main Warehouse 5",


"loca'on_code": "LOC3214",

"contact_person_phone_1": "123456709091032891",

"contact_person_phone_2": "1234567891",

"city": "Lahore",

"contact_person_name": "Aizaz Leo",

"contact_person_email": "contact@[Link]",

"loca'on_address": "Warehouse Area, Block B",

"is_pickup": true,

"is_return": true

Sample Response: -
{

"status_code": 201,

"message": "Address created successfully"

Get Payment Status (Get API)


This API is for fetching payment details of tracking numbers. The required header and values are
men9oned.

URL: hJps://[Link]/api/custom/v1/get-payment-
status/?tracking_numbers=["T0000174287403029"]

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

{
tracking_numbers: ["T0000174287403029", “T0000141999638751”]

Sample Response: -
{

"reference_number": "Re",

"tracking_number": "T0000154284402295",

"reserve_invoice_number": "INV-0000100000016",

"reserve_invoice_amount": 5600.0,

"reserve_seJlement_date": "2025-10-04",

"advance_invoice_number": null,

"advance_invoice_amount": null,

"advance_seJlement_date": null,

"shipper_fee": 330.0,

"fuel_adjustment": 33.0,

"cash_handling_fee": null,

"shipper_tax": 58.08,

"early_payment_fee": null,

"wh_income_tax": 103.58,

"wh_sale_tax": 103.58,

"ds_shipment_type": "Regular",

"ds_order_status": "Delivered",

"order_weight": 4.0,

"advance_amount": null,

"reserve_amount": null,

"balance_amount": 5600.0,

"net_amount": 4971.76

}
Get Merchant Invoice Logs (Get API)
This API is for fetching all invoices during the period defined. The required header and values are
men9oned.

URL: hJps://[Link]/api/custom/v1/merchant-invoice-logs/?date_from=2025-10-
25&date_to=2025-11-30

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

date_from: " 2025-10-25"

date_to: " 2025-11-25"

Sample Response: -
{

"invoice_number": "INV-0000100000023",

"total_orders": 2,

"invoice_amount": "406.00",

"net_amount": "406.00",

"carry_forward": "0.00",

"invoice_type": "Corporate Invoice",

"status": "SeJled",

"invoice_date": "2025-11-21"

},
Get Invoice Detail (Get API)
This API is for fetching all orders against the invoice. The required header and values are men9oned.

URL: hJps://[Link]/api/custom/v1/merchant-invoice-detail/?invoice_number=INV-
0000100000023

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

invoice_number: “ INV-0000100000023"

Sample Response: -
{

"tracking_number": "T0000120525367319",

"invoice_amount": "0.00",

"shipper_fee": "10020.00",

"shipper_tax": "1763.52",

"early_payment_fee": "0.00",

"fuel_adjustment": "1002.00",

"cash_handling_fee": "0.00",

"ds_shipment_type": "Regular",

"ds_order_status": "Delivered",

"order_weight": "12.00",

"advance_amount": "0.00",

"reserve_amount": "0.00",

"balance_amount": "0.00",

"wh_income_tax": "0.00",

"wh_sale_tax": "0.00"
},

Airway Bills (Post API)


This API is for fetching airways against the orders. The required header and values are men9oned.

URL: hhps://api-integra'[Link]/api/custom/v1/print-airway-bill/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Query Params: -

"tracking_numbers":["T0000158970307729", "T0000113342992792"] }

Create Pickup (Post API)


This API is for crea9ng pickup sheet against the orders for a specific loca9on. The required header and
values are men9oned.

URL: hJps://[Link]/api/custom/v1/create-pickup-sheet/Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Body: -

"tracking_numbers": ["T0000104294889836", "T0000157412528647"],

"pickup_loca9on_code": "TMLO"

Sample Response:
{

"pickup_sheet_id": 11672,

"pickup_sheet_number": "PS-0000155",
"message": "Pickup Sheet created Successfully.",

"status": 201

View Pickup Sheet (Get API)


This API is for gesng pdf of a pickup sheet against pickup_sheet_id. The required header and values are
men9oned.

URL: hhps://api-integra'[Link]/api/custom/v1/print-pickup-sheet/10297/

Request Headers: -

Header Key: api-token

Header Value: 09f4924c715a474385938f7fef946e04

Create Store (Post API)


This API is for creating a store. The required header and values are mentioned.

URL: [Link]
Request Headers: -
Header Key: api-token
Header Value: 09f4924c715a474385938f7fef946e04
Body:
{

"name": "Test Store 3",

"city": 117,

"is_allow_to_open": 1,

"support_email": "test@[Link]"}

Sample Response: -
{
"id": 891,

"store_name": "Test Store 3",

"city": "Lahore",

"support_email": "test@[Link]",

"bank": "Habib Bank Ltd.",

"bank_account_'tle": null,

"iban_acc_number": null,

"store_status": "Live",

"created_at": "2026-01-05T19:05:58.260432",

"created_by": "Test Merchant One",

"merchant_name": "Test Merchant One",

"store_code": "891",

"is_allow_to_open": 1

You might also like