Skip to main content

B2B Create Order API:

Description: Creates a B2B order

Basic Information

NAMEDETAILS
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:


ParameterRequiredRemarkValidation
order_idMandatorySeller order IDMinimum 1 character. Must be unique per seller.
order_dateMandatoryOrder creation dateFormat: YYYY-MM-DD. Cannot be future date.
store_nameMandatoryStore name created on RapidShypIf single channel, pass "DEFAULT". Must exist in system.
payment_typeMandatoryPayment modeAllowed values: COD, PREPAID. Case sensitive.
pickup_locationMandatoryPickup location name created on RapidShypMust exist in seller configuration.
shipping_addressMandatoryConsignee details objectValid object. All mandatory child fields must be present.
shipping_address.nameMandatoryConsignee nameMinimum 1 character.
shipping_address.mobile_numberMandatoryConsignee phone number10 digit number.
shipping_address.address_line_1MandatoryConsignee address line 1Between 3 and 100 characters.
shipping_address.address_line_2Non-MandatoryConsignee address line 2If provided, between 3 and 100 characters.
shipping_address.pincodeMandatoryConsignee pincodeMust be valid 6 digit serviceable pincode.
billing_addressConditionally-MandatoryBilling details if different from shippingIf billing_as_shipping = false then we will consider billing_address
billing_address.nameMandatoryBilling nameMinimum 1 character.
billing_address.mobile_numberMandatoryBilling phone number10 digit number.
billing_address.address_line_1MandatoryBilling address line 1Between 3 and 100 characters.
billing_address.address_line_2Non-MandatoryBilling address line 2If provided, between 3 and 100 characters.
billing_address.pincodeMandatoryBilling pincodeMust be valid 6 digit pincode.
invoicesMandatoryInvoice listMinimum 1 invoice required.
invoices.invoice_numberMandatorySeller invoice referenceMinimum 1 character. Must be unique within order.
invoices.invoice_dateMandatoryInvoice dateFormat: YYYY-MM-DD. Cannot be future date.
invoices.invoice_valueMandatoryTotal invoice amountMust be greater than 0.
invoices.gst_numberNon-MandatoryGST numberIf provided, must be valid GST format.
invoices.item_linesMandatoryItem level details per invoiceMinimum 1 item required.
invoices.item_lines.product_nameMandatoryProduct descriptionBetween 3 and 200 characters.
invoices.item_lines.skuMandatorySKU codeMinimum 1 character.
invoices.item_lines.number_of_boxesMandatoryNumber of cartonsInteger. Must be greater than 0.
invoices.item_lines.dead_weight_per_boxMandatoryWeight per boxMust be greater than 0.
invoices.item_lines.lengthMandatoryBox lengthIn cm. Must be greater than 0.
invoices.item_lines.breadthMandatoryBox breadthIn cm. Must be greater than 0.
invoices.item_lines.heightMandatoryBox heightIn cm. Must be greater than 0.

Response:

JSON

{
"status": "SUCCESS",
"remarks": "SUCCESS",
"orderId": "B2B_205",
"orderCreated": true
}