POST /orders

Deprecated

Chargebee no longer supports this endpoint, see here for more information. Contact Support for additional assistance or if you have concerns about this update.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`id`	String	No	Uniquely identifies the order. If not given, this will be auto-generated.
`batch_id`	String	No	Unique id to identify a group of orders.
`note`	String	No	The custom note for the order.
`tracking_id`	String	No	The tracking id of the order.
`invoice_id`	String	Yes	The invoice number which acts as an identifier for invoice and is generated sequentially.
`tracking_url`	String	No	The tracking url of the order.
`fulfillment_status`	String	No	The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;.
`status`	String	No	The order status. * cancelled - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system * new - Order has been created. Applicable only if you are using Chargebee's legacy order management system. * voided - Order has been voided. Applicable only if you are using Chargebee's legacy order management system * complete - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system * processing - Order is being processed. Applicable only if you are using Chargebee's legacy order management system Possible values: `"new"` `"complete"` `"voided"` `"processing"` `"cancelled"`
`reference_id`	String	No	Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is same as the order id in the third party application.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.