Get Orders

Retrieve the details for all Orders that have been placed through your app_id.

Get Orders

get

Retrieves a paginated list of all orders accessible to the authenticated app. Results can be filtered by last modified date range using ISO 8601 formatted date parameters. Returns a VioletPage object containing the order list and pagination metadata including total pages, total elements, and page position. Orders are returned in descending order by creation date.

Query parameters

pageinteger · int32Optional

Page number to retrieve, starting from 1

Default: 1Example: 1

sizeinteger · int32Optional

Number of orders per page (default 20, max 100)

Default: 20Example: 20

date_last_modified:minstringOptional

Return only orders modified after this date. Uses ISO 8601 format.

Example: 2024-01-15T00:00:00+0000

date_last_modified:maxstringOptional

Return only orders modified before this date. Uses ISO 8601 format.

Example: 2024-12-31T23:59:59+0000

Header parameters

X-Violet-TokenstringRequired

API token for authentication

X-Violet-App-SecretstringRequired

Application secret key

X-Violet-App-Idinteger · int32Required

Application ID

Example: 10000

Responses

200

success

application/json

lastbooleanOptional

Boolean indicating if this is the last page

total_pagesinteger · int32Optional

The total count of pages available

total_elementsinteger · int32Optional

The total count of objects available

firstbooleanOptional

Boolean indicating if this is the first page of the response

number_of_elementsinteger · int32Optional

The total number of objects in this specific response

sizeinteger · int32Optional

The page size selected at request time

numberinteger · int32Optional

The page number selected at request time

emptybooleanOptional

Boolean indicating if the response content is empty

next_page_cursorstringOptional

Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.

403

forbidden

application/json

500

internal server error

application/json

get

/orders

HTTPcURLJavaScriptPython

GET /v1/orders HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

{
  "content": [
    {
      "id": 10000,
      "token": "fz8x7gksdjsy2p9fdlonw7k9svwjso4b",
      "app_id": 10000,
      "developer_id": 10000,
      "customer": {
        "first_name": "Super",
        "last_name": "Mario",
        "email": "[email protected]"
      },
      "bags": [
        {
          "id": 11111,
          "order_id": 10000,
          "merchant_id": 10000,
          "status": "COMPLETED",
          "fulfillment_status": "FULFILLED",
          "financial_status": "PAID",
          "skus": [
            {
              "id": 10000,
              "sku_id": 99999,
              "name": "Nintendo Entertainment System",
              "quantity": 2,
              "price": 9999,
              "line_price": 19998
            }
          ],
          "sub_total": 19998,
          "shipping_total": 644,
          "tax_total": 2050,
          "total": 22692,
          "platform": "SHOPIFY",
          "bag_id": 11111,
          "bag_status": "COMPLETED",
          "merchant_name": "Legacy Games"
        }
      ],
      "sub_total": 19998,
      "shipping_total": 644,
      "tax_total": 2050,
      "total": 22692,
      "status": "COMPLETED",
      "date_created": "2024-06-28T20:31:56+0000",
      "date_last_modified": "2024-06-28T20:31:56+0000",
      "currency": "USD",
      "order_id": 10000
    }
  ],
  "last": false,
  "total_pages": 5,
  "total_elements": 92,
  "first": true,
  "number_of_elements": 20,
  "size": 20,
  "number": 1,
  "empty": false
}