Pricing Templates
Log in Sign up
Integrations / Chargebee Product / ...

POST /exports/orders

This API triggers export of order data. The exported zip file contains CSV files with order-related data.

Servers

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
order Object No

Parameters for order
order.is_resent Object No

Order is resent order or not.
order.is_resent.is String No

Possible values:

  • "false"
  • "true"
order.refundable_credits_issued Object No

The total amount issued as credits on behalf of this order.
order.refundable_credits_issued.gt String No
order.refundable_credits_issued.lte String No
order.refundable_credits_issued.between String No
order.refundable_credits_issued.gte String No
order.refundable_credits_issued.is_not String No
order.refundable_credits_issued.lt String No
order.refundable_credits_issued.is String No
order.shipping_date Object No

This is the date on which the order will be delivered to the customer.
order.shipping_date.on String No
order.shipping_date.after String No
order.shipping_date.between String No
order.shipping_date.before String No
order.shipped_at Object No

The time at which the order was shipped.
order.shipped_at.on String No
order.shipped_at.after String No
order.shipped_at.between String No
order.shipped_at.before String No
order.resent_status Object No

Resent order status.
order.resent_status.not_in String No
order.resent_status.in String No
order.resent_status.is_not String No

* `fully_resent` - Order is Fully resent * `partially_resent` - Order is Partially resent

Possible values:

  • "fully_resent"
  • "partially_resent"
order.resent_status.is String No

* `fully_resent` - Order is Fully resent * `partially_resent` - Order is Partially resent

Possible values:

  • "fully_resent"
  • "partially_resent"
order.status Object No

The status of this order.
order.status.not_in String No
order.status.in String No
order.status.is_not String No

* `new` - Order has been created. 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 * `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system * `cancelled` - Order has been cancelled. 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 * `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee * `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform * `on_hold` - The order is paused from being processed. * `delivered` - The order has been delivered to the customer. * `shipped` - The order has moved from order management system to a shipping system. * `partially_delivered` - The order has been partially delivered to the customer. * `returned` - The order has been returned after delivery.

Possible values:

  • "shipped"
  • "returned"
  • "on_hold"
  • "new"
  • "complete"
  • "queued"
  • "voided"
  • "awaiting_shipment"
  • "delivered"
  • "processing"
  • "cancelled"
  • "partially_delivered"
order.status.is String No

* `new` - Order has been created. 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 * `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system * `cancelled` - Order has been cancelled. 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 * `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee * `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform * `on_hold` - The order is paused from being processed. * `delivered` - The order has been delivered to the customer. * `shipped` - The order has moved from order management system to a shipping system. * `partially_delivered` - The order has been partially delivered to the customer. * `returned` - The order has been returned after delivery.

Possible values:

  • "shipped"
  • "returned"
  • "on_hold"
  • "new"
  • "complete"
  • "queued"
  • "voided"
  • "awaiting_shipment"
  • "delivered"
  • "processing"
  • "cancelled"
  • "partially_delivered"
order.original_order_id Object No

If resent order what is the parent order id.
order.original_order_id.starts_with String No
order.original_order_id.is_not String No
order.original_order_id.is String No
order.price_type Object No

The price type of the order
order.price_type.not_in String No
order.price_type.in String No
order.price_type.is_not String No

* `tax_exclusive` - All amounts in the document are exclusive of tax. * `tax_inclusive` - All amounts in the document are inclusive of tax.

Possible values:

  • "tax_exclusive"
  • "tax_inclusive"
order.price_type.is String No

* `tax_exclusive` - All amounts in the document are exclusive of tax. * `tax_inclusive` - All amounts in the document are inclusive of tax.

Possible values:

  • "tax_exclusive"
  • "tax_inclusive"
order.updated_at Object No

Filter based on the time at which order has been updated.
order.updated_at.on String No
order.updated_at.after String No
order.updated_at.between String No
order.updated_at.before String No
order.id Object No

Uniquely identifies the order. It is the api identifier for the order
order.id.not_in String No
order.id.starts_with String No
order.id.in String No
order.id.is_not String No
order.id.is String No
order.delivered_at Object No

The time at which the order was delivered
order.delivered_at.on String No
order.delivered_at.after String No
order.delivered_at.between String No
order.delivered_at.before String No
order.customer_id Object No

The customer for which the order is created
order.customer_id.not_in String No
order.customer_id.starts_with String No
order.customer_id.in String No
order.customer_id.is_not String No
order.customer_id.is String No
order.refundable_credits Object No

The total amount that can be issued as credits for this order.
order.refundable_credits.gt String No
order.refundable_credits.lte String No
order.refundable_credits.between String No
order.refundable_credits.gte String No
order.refundable_credits.is_not String No
order.refundable_credits.lt String No
order.refundable_credits.is String No
order.cancelled_at Object No

The time at which the order was cancelled.
order.cancelled_at.on String No
order.cancelled_at.after String No
order.cancelled_at.between String No
order.cancelled_at.before String No
order.amount_paid Object No

Total amount paid for the order.
order.amount_paid.gt String No
order.amount_paid.lte String No
order.amount_paid.between String No
order.amount_paid.gte String No
order.amount_paid.is_not String No
order.amount_paid.lt String No
order.amount_paid.is String No
order.order_date Object No

The date on which the order will start getting processed.
order.order_date.on String No
order.order_date.after String No
order.order_date.between String No
order.order_date.before String No
order.subscription_id Object No

To filter based on subscription_id.
order.subscription_id.not_in String No
order.subscription_id.starts_with String No
order.subscription_id.in String No
order.subscription_id.is_not String No
order.subscription_id.is String No
order.subscription_id.is_present String No

Possible values:

  • "false"
  • "true"
total Object No

optional, in cents filter Total amount charged for the order. **Supported operators :** is, is_not, lt, lte, gt, gte, between **Example →** *total\[is\] = "1394532759"*
total.gt String No
total.lte String No
total.between String No
total.gte String No
total.is_not String No
total.lt String No
total.is String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy