Search order offers

 

Query Params
string

Search for specific order offer ID(s). Comma separate for multiple.

integer

Search for order offers for a specific customer ID.

string

Search for order offers for a specific customer email.

integer | null
enum
  • 1 - Active
  • 2 - Cancelled
  • 3 - Complete
  • 4 - Partial
  • 5 - Declined
  • 6 - Archive
  • 7 - Rejected
  • 8 - Removed
  • 9 - Paused
  • 10 - Expired
integer

Search for order offers by offer ID.

date-time

Return only order offers that were created on or after this date. A date to and from field is required when not passing order offer id(s), a customer ID, or a customer email.

date-time

Search order offers that were created on or before this date. Required when passing date_created_from. Maximum date range: 31 days.

date-time

Return only order offers that were ordered ( completed ) on or after this date. A date to and from field is required when not passing order offer ID(s), a customer ID, or a customer email.

date-time

Search order offers that were ordered ( completed ) on or before this date. Required when passing date_ordered_from. Maximum date range: 31 days.

date-time

Return only order offers that were cancelled on or after this date. A date to and from field is required when not passing order offer ID(s), a customer ID, or a customer email.

date-time

Search order offers that were cancelled on or before this date. Required when passing date_cancel_from. Maximum date range: 31 days.

string
enum

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=discount,campaign)

integer

Limit the number of results. Default: 200, max: 200.

integer

Offset the results

string

Field to sort result by

string
enum

Order by asc or desc

Allowed:
boolean
boolean
string
string
string
enum
Allowed:
date-time
date-time
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json