Xpressbees B2C SPS
Xpressbees Logistics is a logistics company that provides end-to-end supply chain solutions, including first-mile, last-mile delivery, storage, and WMS.
Courier Partner ID: 6
Services Integrated:
- Order Creation
- Order Cancellation
- Tracking via Polling
- Tracking via Webhooks
- Proof of Delivery
Steps to setup Xpressbees B2C SPS on Clickpost
-
Firstly, complete the process of setting up a courier partner account by following the steps: https://docs.clickpost.ai/docs/create-an-courier-partner-account
-
This is the screen that you'll get :
Here, you can add the credentials as shared by the Xpressbees team. To give you a brief:
| Name | value | description |
|---|---|---|
pickup vendor code | String | It is a mandatory field used to identify the pickup location vendor. |
service_type | SD or NDD or SDD | This field specifies the type of shipment delivery. SDD -> Same-day delivery NDD -> Next-day delivery SD -> Standard Delivery |
getshipmentstatusurl | GetShipmentSummaryDetails URL | This API endpoint is used to fetch the shipment tracking summary details from the Xpressbees system. |
getshipmentstatus xb key | GetShipmentSummaryDetails XB Key | Will be shared by the XpressBees team. |
addmanifestdetails url | OrderCreation_PushPreshipManifest URL | This API is required to push the data to the XpressBees system. It acts as an API endpoint for order creation. |
addmanifestdetails xb key | addmanifestdetails XB Key | Will be shared by the XpressBees team. |
RTOnotifyshipment url | CancellationRTO_NotifyRTOShipment | To notify the enterprises for orders that are marked as RTO. |
RTOnotifyshipment xb key | CancellationRTO_NotifyRTOShipment XB Key | Will be shared by the XpressBees team. |
awbnumberseriesgeneration url | AWBNumberSeriesGeneration URL | This API is required to send a request to XpressBees systems to auto-generate the AWBs. (optional) |
awbnumberseriesgeneration xb key | AWBNumberSeriesGeneration XB Key | Will be shared by the XpressBees team. |
getAWBnumbergeneratedseries url | AWBNumberGeneratedSeries URL | This API is required to fetch the AWBs generated by XpressBees when we send the request using the above awbseriesgeneration API. (optional) |
getAWBnumbergeneratedseries xb key | AWBNumberGeneratedSeries XB Key | Will be shared by the XpressBees team. |
updatendr url | Update_NDR URL | This is used to update NDR instructions in XpressBees systems |
updatendr xb key | Update_NDR XB Key | Will be shared by the XpressBees team. |
username | Enterprise ID | To generate the Tokens needed for Xpressbees APIs. You will get it from your Xpressbees relationship manager. (Mandatory if the Auth type is NEW) |
password | password | To generate the Tokens needed for Xpressbees APIs. You will get it from your Xpressbees relationship manager. (Mandatory if the Auth type is NEW) |
secret key | XB Key | XB Access Key ID of the service owner who will be granting anonymous access for a request that satisfies the set of constraints in the policy. You will get it from your Xpressbees relationship manager. |
auth type | OLD or NEW | OLD: It refers to static key-based authentication for order/shipment manifestation. (Clickpost supports the endpoint URL and the static key flow. ) NEW: It refers to dynamic token-based authentication for order/shipment manifestation (To be used to call the new manifestation API.) |
Business_account_name | EnterpriseBusiness Name | It is a name allocated to a business in the XB systems This is required in the Order Creation API and has validation against it. |
OTP based delivery | YES or NO | It is a Mandatory field that signifies if an OTP verification is required at the receiver end for the shipment delivery then we use "YES" if not "NO". (By default it is "No") |
Enable pre assign awb flow | YES (default) or NO | Yes - indicates the Pre-assigned flow is set and uploaded AWBs will be sent in the payload and the same would be received in response. NO - In this case only a few customers have the account configured by the Xpressbee side where Real-time AWB generation would be the process. In this case, No need to upload pre-assign AWBs. |
- Once done, kindly press Submit and you have set up Xpressbees on Clickpost.
Pre-assigned AWBs: In case you are activating Xpressbees B2C SPS for order creation, you need to upload Pre-assigned AWBs as Xpressbees B2C systems only support order creation with Pre-assigned AWBs.
You need to get the Pre-assigned AWBs list from your Xpressbees relationship manager and upload it on the Clickpost dashboard in the pre-assigned AWBs section. This is a mandatory step before you start using order creation via Clickpost for Xprebessbees B2C MPS.
Steps to upload Pre-assigned AWBs in Clickpost: https://docs.clickpost.ai/docs/courier-partner-integration
Note:
- Labels: Clickpost does generate a label for Xpreebees B2C SPS orders. Labels are generated by Clickpost and returned in API response to the customer
Updated 8 days ago