Order Wrapper API:
Description: Creates order, assigns courier and initiates shipment in a single API call.
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Mandatory |
| URL: | https://api.rapidshyp.com/rapidshyp/apis/v1/b2b/orders/b2b_ext_order_wrapper |
| Request Type: | POST |
| Scheme: | HTTPS |
| Header (content-type): | application/json |
| Header (rapidshyp-token): | API-Key |
Curl
curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/b2b/orders/b2b_ext_order_wrapper'
--header 'rapidshyp-token: <API_KEY>'
--header 'Content-Type: application/json'
--data '{
"order_id": "1111111",
"pickup_location": "DelhiLL",
"is_to_pay": true,
"invoices": [
{
"invoice_number": "1234",
"invoice_value": 10000,
"item_lines": [
{
"product_name": "Test product",
"sku": "TESTSKU",
"number_of_boxes": 1,
"dead_weight_per_box": 10
}
]
}
]
}'
Request Parameters:
| Parameter | Required | Remark | Validation |
|---|---|---|---|
| order_id | Yes | Seller order ID | Unique |
| pickup_location | Yes | Pickup location | Must exist |
| is_to_pay | Yes | To-pay shipment | true/false |
| invoices | Yes | Invoice details | Min 1 invoice |
Response:
JSON
{
"status": "SUCCESS",
"remarks": "Request sent to courier for assignment.",
"orderId": "B2B_ORDWR_002",
"orderCreated": true
}