Skip to content
My API Logo API Documentation

FAQ

Frequently Asked Questions (FAQ)

Authentication & Headers

Q: What headers are required for all API requests? A: All API requests require the following headers:

  • X-TENANT-ID: Your tenant identifier (e.g., “tenant1”, “SMILe”, “NBA”)
  • X-USER-ID: Your user identifier
  • Content-Type: application/json

Q: How do I get my tenant ID and user ID? A: Contact your system administrator or the API provider to obtain your tenant ID and user ID credentials. It’s getting created at the time of onboarding.

Booking Creation

Q: What is the difference between orderId and referenceId? A:

  • orderId: System-generated UUID that serves as the primary unique identifier for the order
  • referenceId: Optional custom reference ID that you can provide for your own tracking purposes

Q: Is the orderId required in the request body? A: No, the orderId is automatically generated by the system when creating a new order. You should not include it in your request body.

Q: What happens if I don’t provide billing and return addresses? A: If billing and return addresses are not provided, the system will automatically use:

  • Pickup address as the return address
  • Delivery address as the billing address

Shipments & Items

Q: Can one order have multiple shipments? A: Yes, one order can have multiple shipments. Each shipment can contain multiple items.

Q: What is the difference between physicalWeight and volumetricWeight? A:

  • physicalWeight: Actual weight of the shipment in kg
  • volumetricWeight: Calculated weight based on dimensions (length × width × height × volumetric factor)

Q: When should I use isParent and isChild flags? A: Use these flags when you have parent-child shipment relationships:

  • isParent: true for the main shipment
  • isChild: true for sub-shipments that belong to a parent shipment

Reference & SPOC for modules

Onboarding:

Reference: https://docs.prayog.io/onboarding-api/onboarding-api/


SPOC: Mayank Rai

Serviceability:

Reference: https://docs.prayog.io/serviceability-api/onboarding-pincode-api/


SPOC: Avinash Kumar Singh

Configurations:

Reference: Not available


SPOC: Yash Barge

Rate card:

Reference: https://docs.prayog.io/rates-and-charges/ratecard-api/


SPOC: Mayur Rana

Preseries:

Reference: https://docs.prayog.io/preseries-api/preseries-api/


SPOC: Mayank Rai

Slots:

Reference: https://docs.prayog.io/slots/booking-apis/


SPOC: Sonu Verma

Tracking:

Reference: https://docs.prayog.io/tracking-api/tracking-api-docs/


SPOC: Arpan Mukharjee