v1(Latest)v2

Order Wrapper API:

Description: Creates B2B 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": "#B2#B_#160",
  "order_date": "2026-02-04",
  "store_name": "DEFAULT",
  "payment_type": "COD",
  "pickup_location": "DIVYA TESTqa",
  "courier_code": "",
  "is_to_pay": true,
  "appointment_based_delivery": true,
  "billing_as_shipping": true,
  "shipping_address": {
    "name": "Abhi",
    "mobile_number": "9999999999",
    "email": "",
    "address_line_1": "AAAAAAAAAAAAAAAAAAA",
    "address_line_2": "",
    "pincode": "110002"
  },
  "billing_address": {
    "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "mobile_number": "9999999999",
    "email": "",
    "address_line_1": "QQQQQQQQQQQQQQQQ QQQQQQQQQQQQ FFFFFFFFFFFFFFFFFFFFFF",
    "address_line_2": "HELLO qqqq EEEEEEEEEEEEE AAAAAAA DDDDDDDDDDDDDDDDDDDD",
    "pincode": "201301"
  },
  "invoices": [
    {
      "invoice_number": "A",
      "invoice_date": "2026-01-01",
      "eway_bill_number": "12345678912",
      "eway_expiry_date": "2026-12-27",
      "prepaid_amount": 0,
      "invoice_value": 100,
      "invoice_document": "https://filesamples.com/samples/image/jpeg/sample_640×426.jpeg",
      "item_lines": [
        {
          "product_name": "ABHAA",
          "sku": "ABCD",
          "number_of_boxes": 3,
          "dead_weight_per_box": 2,
          "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
courier_code	Optional	Courier partner code	Must be serviceable if provided
is_to_pay	Optional	Indicates if shipment is To-Pay	Boolean value (true/false)
appointment_based_delivery	Optional	Flag for appointment-based delivery	Boolean value
billing_as_shipping	Optional	Whether billing address same as shipping	Boolean value
shipping_address	Mandatory	Consignee details object	Valid object containing required fields
shipping_address.name	Mandatory	Consignee name	Minimum 1 character
shipping_address.mobile_number	Mandatory	Consignee phone number	Must be 10 digit number
shipping_address.email	Optional	Consignee email	Must be valid email format if provided
shipping_address.address_line_1	Mandatory	Consignee address line 1	Between 3 and 100 characters
shipping_address.address_line_2	Optional	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	Conditional	Billing details object	Considered if billing_as_shipping = false
billing_address.name	Mandatory	Billing name	Minimum 1 character
billing_address.mobile_number	Mandatory	Billing phone number	Must be 10 digit number
billing_address.email	Optional	Billing email	Must be valid email format if provided
billing_address.address_line_1	Mandatory	Billing address line 1	Between 3 and 100 characters
billing_address.address_line_2	Optional	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.eway_bill_number	Optional	E-Way bill number	Must be valid if provided
invoices.eway_expiry_date	Optional	E-Way bill expiry date	Format: YYYY-MM-DD
invoices.prepaid_amount	Optional	Prepaid amount	Numeric value
invoices.invoice_value	Mandatory	Total invoice amount	Must be greater than 0
invoices.invoice_document	Optional	Invoice document URL	Must be valid URL
invoices.item_lines	Mandatory	Item level details for 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": "Request sent to courier for assignment. You will receive response on the configured URL.",
  "orderId": "#B2#B_#161",
  "orderCreated": true,
  "shipment": [
    {
      "shipment_id": "BS260326",
      "chargeable_weight": 500.0,
      "payment_type": "COD",
      "invoice_number": "A",
      "invoice_date": "2026-01-01 00:00:01",
      "eway_bill_number": "12345678912",
      "eway_expiry_date": "2026-12-27 18:29:59",
      "transporter_id": "88AAECO4660K1Z7",
      "child_courier_code": 2000003,
      "child_courier_name": "Om Logistics Express B2B",
      "parent_courier_name": "OM LOGISTICS",
      "prepaid_amount": 0.0,
      "collectable_amount": 100.0,
      "invoice_value": 100.0,
      "invoice_document": "https://filesamples.com/samples/image/jpeg/sample_640×426.jpeg",
      "shipment_lines": [
        {
          "product_name": "ABHAA",
          "sku": "ABCD",
          "number_of_boxes": 3,
          "dead_weight_per_box": 2.0,
          "length": 1.0,
          "breadth": 1.0,
          "height": 1.0,
          "price_per_box": 0.0
        }
      ]
    }
  ]
}