List Orders

GET {{baseUrl}}/orders

This API is meant to return a small subset of orders. By default the last 3 months are returned.

If you would like to retrieve all orders for Reporting / BI purposes we recommended a different approach, please contact your account manager for more information.

By default only the latest revision will be returned.

Request Params

For caching purposes we recommend using the If-Modified-Since header instead. | | booking_reference | string | | [FILTER] on booking_reference. | | booking_external_reference | string | | [FILTER] on booking_external_reference. | | product_id | string | | [FILTER] on product_id. | | product_type_code | number | | [FILTER] on product_type_code. | | product_availability_id | number | | [FILTER] on product_availability_id. | | product_availability_capacity_id | number | | [FILTER] on product_availability_capacity_id. | | order_created_email | string | | [FILTER] on order_created_email. Only the orders made by this user / cashier will be returned. | | order_search_query | string | | [SEARCH] on keywords. This API provides full-text (wildcard) search capabilities.

Only results linked to your account will be returned and searching is only available in case cache is enabled (cache:true) | | filter_bookings | boolean | | [CONFIG] Filter (sub) bookings from response.

Whether to include all bookings belonging to the same order or only those matching the defined filters. By default the system will return every booking of an order, regardless whether some of those bookings do not match the defined filters.

For example. when a filter for product_id is set, only orders which contain that product will be returned, but additional bookings (for different product IDs) of that same order might be listed as well. By enabling this filter, only bookings for that product_id would be returned. | | order_view_type | string | | [CONFIG] (ADVANCED) account view type.

This value defaults and is limited to the scope of your credentials. | | order_sort_by | string | | [SORT] Select sorting method.

UPCOMING: [INVOICE_DATE]. | | order_sort_order | string | | [SORT] Keyword used to sort result sets in either ascending or descending order. | | items_per_page | number | | [PAGING] Items Per Page - Allows user's to configure the items_per_page value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100. This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.

Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page response element in calculating actual page size. | | start_index | number | | [PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200. | | page | number | | [PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index and total_pages properties are used for this style of paging. | | cache | boolean | | [CACHE] Whether the results should be loaded from the caching server. This will significantly improve performance and disabling this functionality is not recommended. |

HEADERS

Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method. |

RESPONSES

status: OK

{"api_version":"3.4.0","data":{"current_item_count":10,"items":[{"order_bookings":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_channel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_created":"1956-08-03T02:03:45.159Z","order_created_email":"cashier@prioticket.com","order_created_name":"Demo Cashier","order_distributor_id":"501","order_distributor_name":"Demo Distributor","order_external_reference":"EXTERNALREF123","order_language":"en","order_modified":"1949-05-25T14:43:45.736Z","order_platform_id":"1","order_platform_name":"Platform Name","order_pricing":{"price_variations":[{"variation_label":"Peak Hour","variation_amount":"2.50","variation_type":"PRODUCT_DYNAMIC"}],"exercitation117":-41451930.29384471,"utc4":"Duis labore"},"order_reference":"ORDRREF123456","order_reseller_id":"1300","order_reseller_name":"Demo reseller","order_status":"ORDER_CONFIRMED","order_version":1,"order_view_type":"DISTRIBUTOR","order_partner_id":"4534543543","order_partner_name":"Partner Name","order_settlement_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_contacts":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_promocodes":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_payments":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_invoices":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_flags":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_custom_fields":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_notes":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_activity_url":"https://activity.prioticket.com/orders/ORDRREF123456","order_customer_url":"https://customer.prioticket.com/orders/ORDRREF123456","order_confirmed":"1999-07-29T07:11:45.120Z","order_cancellation_date_time":"2020-08-28T20:13:33.510Z"},{"order_bookings":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_channel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_created":"1975-09-18T19:06:03.528Z","order_created_email":"cashier@prioticket.com","order_created_name":"Demo Cashier","order_distributor_id":"501","order_distributor_name":"Demo Distributor","order_external_reference":"EXTERNALREF123","order_language":"en","order_modified":"1983-01-22T02:39:28.402Z","order_platform_id":"1","order_platform_name":"Platform Name","order_pricing":{"price_variations":[{"variation_label":"Peak Hour","variation_amount":"2.50","variation_type":"PRODUCT_DYNAMIC"}],"occaecatf":"sunt laboris reprehenderit","exercitation0":"labor"},"order_reference":"ORDRREF123456","order_reseller_id":"1300","order_reseller_name":"Demo reseller","order_status":"ORDER_CONFIRMED","order_version":1,"order_view_type":"DISTRIBUTOR","order_partner_id":"4534543543","order_partner_name":"Partner Name","order_settlement_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_contacts":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_promocodes":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_payments":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_invoices":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_flags":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_custom_fields":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_notes":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_activity_url":"https://activity.prioticket.com/orders/ORDRREF123456","order_customer_url":"https://customer.prioticket.com/orders/ORDRREF123456","order_confirmed":"1982-06-24T19:34:12.708Z","order_cancellation_date_time":"1968-06-06T22:11:51.390Z"}],"items_per_page":10,"kind":"contact","page_index":1,"start_index":1,"total_items":200,"total_pages":20}}