FAQs

1. Can we set the endpoint (custom URL format) for sending the request?

No, the URL should be as per our format only.

2. What is the time for the token expiry?

We’ll be generating token every time while generating AWB or tracking the shipments.

3. Shipping labels in response should be in PDF format links or CSV format links? [waybill API]

PDF format. Refer Waybill Generation API.

4. How frequently can we call tracking status API? Can we do it every 60 mins?

Tracking status API is called 4 times a day. No, it cannot be called every 60 mins.

5. Can we customize the verification API body based on the client (logistics) parameters?

No, it is based on generic signatures that are valid for all partners.

6. What is the purpose of shipper integration, how will it benefit the shipper?

With integrated shipper it becomes easy for the sellers to manage their shipping details, update tracking and process orders from multiple shipper collectively in Uniware. Indirectly it also benefits the shipper by improving customer experience due to timely order processing, timely update of dispacth etc.

7. How to get started with the integration and what is the complete process?

As a first step go through the Basic Overview page to understand the integration flow. The flow mentions both the mandatory and non-mandatory APIs involved in integration.

The page also lists the Elementary and Conditional APIs for ease of understanding. Now, that you know what all information is shared between Uniware and shippers, identify which all APIs are relevant to you (as a thumb rule start with the elementary ones) and refer their respective page(s) to understand the expected request/response structure.

Get in touch with our sales and solutioning team in case of doubts and post that start developing these APIs at your end. Once the APIs are ready we will assist you in testing those APIs and after successful testing the shipper will be live on Uniware. The sellers can now enter their credentials and add the shipper on their Uniware account.

8. How to know which APIs are mandatory?

The usage details i.e. whether it is mandatory or not is mentioned on their individual pages, under Basic Information.

9. What is the standard URL format?

Standard URL: https://{shipperbaseurl}/{endpoint}?{query parameters}.

{shipperbaseurl} : link where the APIs are hosted by shipper.

{endpoint} : mentioned on API page under Basic Information.

{query parameters} : mentioned on API page.

The sample URL is provided for reference on individual API pages also.

10. Can we set the endpoint (custom URL format) for sending the request?

No, the URL should be as per our format only.

11. How to know the default frequency of any API?

The default frequency for relevant APIs is provided on their individual pages, under Basic Information.

12. Can we customize the default API frequency?

No, the default frequency for any APIs cannot be changed. However, the seller can manually run the APIs from the Uniware, if required.

No, this is direct API integration with Seller’s UC account to individual shipper as plug n play.

14. How can we (shipper) keep track of merchants on UC and their opertaions?

No, As stated earlier, this is direct API integration with Seller’s UC account to individual shipper. So the shipper needs to figure out externally how they can track such activities at their Dashboard. if required.

15. Is there any customization possible in this integration which is not handled in listed APIs?

No, As stated earlier this is one time Generic integration, shipper can only opt the listed APIs, for any customization or enhancement requested by SP is not possible.

No, UC won’t offer a staging environment for testing APIs, but we strongly recommend testing the selected APIs on Postman in accordance with the UC-defined API framework before sharing it with the UC team to deploy in the Test production account. Since this is direct API integration with the seller’s UC account, the Channel/Logistics team can carry out the UAT in the test production account prior to the Channel/Shipper going live for all UC’s sellers. To create UAT user in this test account, kindly get in touch with UC integration team.

17. Is there any standardization for the response payload across all the mentioned APIs??

Yes, As stated this is Generic integration, it’s essential to send all mandatory details in one go once they are available. This includes providing all requested details in the response payload to prevent parsing errors.

18. As a shipping partner, what is the procedure for reporting concerns regarding seller issues and monitoring merchant operations on UC?

For seller-specific concerns on current integration flow, It is recommended to submit a case/ticket to UC support chat and share the details with us: Ref support ticket Id : -------------- e.g. UC1566** Uniware Account Name: ------------- e.g. XYZABC.unicommerce.com RCA From Partner side: ------------- Detailed observation basis of impacted APIs name or action taken through in UC