GET /orders
This API is used to retrieve a list of all the available orders.
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 |
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-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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
is_resent |
Object | No |
optional, boolean filterOrder is resent order or not. Possible values are : true, false Supported operators : isExample → is_resent[is] = "false" |
shipping_date |
Object | No |
optional, timestamp(UTC) in seconds filterThis is the date on which the order will be delivered to the customer.Supported operators : after, before, on, betweenExample → shipping_date[after] = "1435054328" |
shipped_at |
Object | No |
optional, timestamp(UTC) in seconds filterThe time at which the order was shipped.Supported operators : after, before, on, betweenExample → shipped_at[before] = "1435054328" |
resent_status |
Object | No |
optional, enumerated string filterResent order status. Possible values are : fully_resent, partially_resent.Supported operators : is, is_not, in, not_inExample → resent_status[is] = "fully_resent" |
status |
Object | No |
optional, enumerated string filterThe status of this order. Possible values are : new, processing, complete, cancelled, voided, queued, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned.Supported operators : is, is_not, in, not_inExample → status[is] = "queued" |
original_order_id |
Object | No |
optional, string filterIf resent order what is the parent order id.Supported operators : is, is_not, starts_withExample → original_order_id[is] = "1xRt6ifdr" |
exclude_deleted_credit_notes |
Boolean | No |
Flag to indicate whether deleted credit notes should be passed or not. |
include_deleted |
Boolean | No |
If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*deleted\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\* ' attribute will be '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*'. Default value: false |
updated_at |
Object | No |
optional, timestamp(UTC) in seconds filterTo filter based on updated at .Supported operators : after, before, on, betweenExample → updated_at[on] = "1243545465" |
id |
Object | No |
optional, string filterUniquely identifies the order. It is the api identifier for the order.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "890" |
paid_on |
Object | No |
optional, timestamp(UTC) in seconds filterThe timestamp indicating the date & time the order's invoice got paid.Supported operators : after, before, on, betweenExample → paid_on[on] = "1435054328" |
limit |
Integer | No |
The number of resources to be returned. Default value: 10 |
invoice_id |
Object | No |
optional, string filterThe invoice number which acts as an identifier for invoice and is generated sequentially.Supported operators : is, is_not, starts_with, in, not_inExample → invoice_id[is] = "INVOICE_982" |
order_type |
Object | No |
optional, enumerated string filterOrder type. Possible values are : manual, system_generated.Supported operators : is, is_not, in, not_inExample → order_type[is_not] = "system_generated" |
order_date |
Object | No |
optional, timestamp(UTC) in seconds filterThe date on which the order will start getting processed.Supported operators : after, before, on, betweenExample → order_date[before] = "1435054328" |
created_at |
Object | No |
optional, timestamp(UTC) in seconds filterThe time at which the order was created.Supported operators : after, before, on, betweenExample → created_at[after] = "1435054328" |
sort_by |
Object | No |
optional, string filterSorts based on the specified attribute. Supported attributes : created_at, updated_atSupported sort-orders : asc, descExample → *sort_by[asc] = "created_at"*This will sort the result based on the 'created_at' attribute in ascending(earliest first) order. |
offset |
String | No |
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set |
subscription_id |
Object | No |
optional, string filterThe subscription for which the order is created.Supported operators : is, is_not, starts_withExample → subscription_id[is_not] = "null" |
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.