B2B Create Order API:
Description: Creates a B2B order
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Mandatory |
| URL: | https://api.rapidshyp.com/rapidshyp/apis/v1/b2b/orders/b2b_ext_create_order |
| 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_create_order'
--header 'rapidshyp-token: <API_KEY>'
--header 'Content-Type: application/json'
--data '{
"order_id": "0000000",
"order_date": "2025-12-30",
"store_name": "DEFAULT",
"payment_type": "COD",
"pickup_location": "DelhiLL",
"shipping_address": {
"name": "AAAAAAAAAAAAAA",
"mobile_number": "9999999999",
"address_line_1": "LONG_ADDRESS_TEST",
"pincode": "110001"
},
"billing_address": {
"name": "aaaa",
"mobile_number": "9999999999",
"address_line_1": "ahhah",
"pincode": "110001"
},
"invoices": [
{
"invoice_number": "1234",
"invoice_date": "2025-12-30",
"invoice_value": 10,
"item_lines": [
{
"product_name": "AAA",
"sku": "AAA",
"number_of_boxes": 2,
"dead_weight_per_box": 10,
"length": 1,
"breadth": 1,
"height": 1
}
]
}
]
}'
Request Parameters:
| Parameter | Required | Remark | Validation |
|---|---|---|---|
| order_id | Mandatory | Seller order ID | Minimum 1 character. Must be unique per seller. |
| order_date | Mandatory | Order creation date | Format: YYYY-MM-DD. Cannot be future date. |
| store_name | Mandatory | Store name created on RapidShyp | If single channel, pass "DEFAULT". Must exist in system. |
| payment_type | Mandatory | Payment mode | Allowed values: COD, PREPAID. Case sensitive. |
| pickup_location | Mandatory | Pickup location name created on RapidShyp | Must exist in seller configuration. |
| shipping_address | Mandatory | Consignee details object | Valid object. All mandatory child fields must be present. |
| shipping_address.name | Mandatory | Consignee name | Minimum 1 character. |
| shipping_address.mobile_number | Mandatory | Consignee phone number | 10 digit number. |
| shipping_address.address_line_1 | Mandatory | Consignee address line 1 | Between 3 and 100 characters. |
| shipping_address.address_line_2 | Non-Mandatory | Consignee address line 2 | If provided, between 3 and 100 characters. |
| shipping_address.pincode | Mandatory | Consignee pincode | Must be valid 6 digit serviceable pincode. |
| billing_address | Conditionally-Mandatory | Billing details if different from shipping | If billing_as_shipping = false then we will consider billing_address |
| billing_address.name | Mandatory | Billing name | Minimum 1 character. |
| billing_address.mobile_number | Mandatory | Billing phone number | 10 digit number. |
| billing_address.address_line_1 | Mandatory | Billing address line 1 | Between 3 and 100 characters. |
| billing_address.address_line_2 | Non-Mandatory | Billing address line 2 | If provided, between 3 and 100 characters. |
| billing_address.pincode | Mandatory | Billing pincode | Must be valid 6 digit pincode. |
| invoices | Mandatory | Invoice list | Minimum 1 invoice required. |
| invoices.invoice_number | Mandatory | Seller invoice reference | Minimum 1 character. Must be unique within order. |
| invoices.invoice_date | Mandatory | Invoice date | Format: YYYY-MM-DD. Cannot be future date. |
| invoices.invoice_value | Mandatory | Total invoice amount | Must be greater than 0. |
| invoices.gst_number | Non-Mandatory | GST number | If provided, must be valid GST format. |
| invoices.item_lines | Mandatory | Item level details per invoice | Minimum 1 item required. |
| invoices.item_lines.product_name | Mandatory | Product description | Between 3 and 200 characters. |
| invoices.item_lines.sku | Mandatory | SKU code | Minimum 1 character. |
| invoices.item_lines.number_of_boxes | Mandatory | Number of cartons | Integer. Must be greater than 0. |
| invoices.item_lines.dead_weight_per_box | Mandatory | Weight per box | Must be greater than 0. |
| invoices.item_lines.length | Mandatory | Box length | In cm. Must be greater than 0. |
| invoices.item_lines.breadth | Mandatory | Box breadth | In cm. Must be greater than 0. |
| invoices.item_lines.height | Mandatory | Box height | In cm. Must be greater than 0. |
Response:
JSON
{
"status": "SUCCESS",
"remarks": "SUCCESS",
"orderId": "B2B_205",
"orderCreated": true
}