Get a list of your orders sorted by recently updated. Providing any query params will further filter the results to only those that match the query params.

get/api/v2/orders/

Request

  • Base URL: https://app.spotdx.com
  • URL: https://app.spotdx.com/api/v2/orders/
  • Auth: API key in header Authorization

Query parameters

emailstring

Only retrieve orders associated with this email address.

first_namestring

Only retrieve orders associated with this first name.

last_namestring

Only retrieve orders associated with this last name.

phonestring

Only retrieve orders associated with this phone number.

status'canceled' | 'completed' | 'in_progress' | 'pending'

Only retrieve orders that have this status.

created_beforestring

Only retrieve orders created on or before this date. Format: YYYY-MM-DD

created_afterstring

Only retrieve orders created on or after this date. Format: YYYY-MM-DD

updated_beforestring

Only retrieve orders updated on or before this date. Format: YYYY-MM-DD

updated_afterstring

Only retrieve orders updated on or after this date. Format: YYYY-MM-DD

resultsinteger

Number of results to return. Must be in range 1-100. Default is 10.

offsetinteger

The initial index from which to return the results.

Response

order_idstring

The order's unique ID.

status'pending' | 'in_progress' | 'completed' | 'canceled'
createdstring date-time

The date and time the order was created.

updatedstring date-time

The date and time the order was last updated.

Example response

[
  {
    "order_id": "O1234567",
    "recipient": {
      "first_name": "Alice",
      "last_name": "Smith",
      "email": "alice123@gmail.com",
      "phone": "1234567890",
      "address": {
        "street1": "123 Main St",
        "street2": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip": "94105"
      }
    },
    "created": "2023-01-01T04:30:11.222Z",
    "updated": "2023-01-01T04:30:11.222Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.