API Reference

Get a list of orders

get
https://biz-sandbox-api.sodagift.com/v1/orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer | null

Id of the order

date | null

Date you want to search based on the date you created the order

date | null

End date for the order search

float | null

Minimum amount for the order search

float | null

Maximum amount for the order search

string
enum

Status of the order items

Allowed:
integer | null
deprecated

Not currently supported — this filter is accepted but has no effect, and the response is not filtered by product. Filter on order_items[].item.id in your own code instead.

string | null

Name of the sender

string
enum

This determines how the voucher will be delivered to the recipient.

Allowed:
string | null

Name of the recipient

string | null

Email of the recipient

string | null

Phone number of the recipient

string | null

Value entered when creating an order

integer
required
0 to 500

Size of each element in the response

integer
required
≥ 0

Page number for pagination

Responses

401

Missing or invalid API key. The response body is empty.

Updated 17 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago

Did this page help you?