View Card Shipping Details API

---

Request Method :: GET

Base URL: Will be shared later.

URL : {BaseUrl} /ppcard/mw/card/card_shipping_report

Description: This API is used to view previously shipping details.

Headers

---

Content-Type: application/JSON

header_secrets: These values must be generated each time while consuming the API (refer to the generation process mentioned in the note above).

client_id:  To be shared during integration by ISU Team

Response Body Parameters

Parameters	Description	Data type
statusCode	Status Code(0/1)	String
statusDesc	Status Description of Status	String
status	SUCCESS/FAILED	String
data Contains following data
pmreport
batch_id	batch id. e.g. 148	String
recipient_name	recipient name. e.g. CORP9861372149	String
recipient_user_id	User id of Recipient	Integer
recipient_user_role	User role of Recipient	String
genlotrefno	e.g. 030924151106374	String
startrefno	start reference no. e.g. 1500000176	String
endrefno	end reference no. e.g. 1500000176	String
card_count	number of cards. e.g.1	String
product_category	category of product. e.g. GIFT	String
card_nature	nature of card. e.g. P	String
created_date	date of creation. e.g.2024-09-03T15:11:08.000Z	String
updated_date	date of update. e.g.2024-09-03T15:11:08.000Z	String
status	Status of operation. e.g. Initiated	String
status_desc	Description of the status	String
used_count	e.g. 1	String
issuancecategory	Issuance category	String
payment_mode	Payment mode, e.g. - Self	String
product_name	name of the product. e.g.GIFTBANKINVENTORYOWN	String
total_amount	Total cost of shipping card	String
sender_name	name of the sender if any sub-user did shipping. e.g. DEMOBANK	String
sender_role	Role of the Sender, E.g. - ROLE_RETAILER	String
programmanger_name	Name of program manager.	String
programmanger_id	Program manager id.
programmanger_role	Program manager Role
admin_name	Name of the admin.	String
amount_per_card	amount per card. e.g. 2	String
address1	Address Line1. e.g. OD Complex	String
address2	Address Line2. e.g. Mominpur	String
state	Name of the state. e.g. WestBengal	String
city	Name of the city. e.g. KolkataNorth	String
country	Name of the country. e.g. India	String
pinType	Type of PIN. e.g. GREENPIN	String
personalization	Personalization. e.g. Indent	String
pincode	PIN code of the area. e.g.700028	Integer

Sample Response Body

---

SUCCESS:

{ "statusCode": 0, "status": "SUCCESS", "statusDesc": "Card report fetched successfully", "data": { "pmreport": [ { "address1": "Balugaon", "address2": "balugaon", "address_type": "Home", "admin_id": "44444", "admin_name": "isu_admin", "admin_role": "ROLE_ADMIN", "amount_per_card": "10", "card_category": "PREPAID", "card_count": "1", "card_nature": "P", "city": "Bhubaneswar", "corporate_id": "", "corporate_name": "", "corporate_role": "", "country": "India", "created_date": "2024-11-18T18:54:24.000Z", "endrefno": "1500000603", "genlotrefno": "181124185418456", "issuancecategory": null, "order_date": "2024-11-18T18:54:24.000Z", "order_status": "CONFIRMED", "payment_mode": "SELF", "personalization": null, "pincode": 752034, "pintype": null, "product_category": "GPR", "product_id": "892114", "product_name": "DEMOPRODUCT", "programmanger_id": "4444430000030692", "programmanger_name": "PROG9345247257", "programmanger_role": "ROLE_MASTER_DISTRIBUTOR", "recipient_name": "CUST7978347959", "recipient_user_id": "4444450000031285", "recipient_user_role": "ROLE_RETAILER", "sender_id": "4444450000031285", "sender_name": "CUST7978347959", "sender_role": "ROLE_RETAILER", "startrefno": "1500000603", "state": "OD", "status": "INITIATED", "status_desc": "Card Shipped Successfully", "sub_status": 0, "total_amount": "10", "updated_date": "2024-11-18T18:54:24.000Z", "used_count": "1" } ] } }

 

FAILED:

{ "statusCode": 1, "status": "FAILED", "statusDesc": "Card report not found" }

 

Detailed Status Codes

Status	Response Type	Description
0	SUCCESS	Card report fetched successfully
1	FAILED	Card report not found