List Orders

GET /orders
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/orders

Returns a list of Orders

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
update_timestring
Timezone: GMT.


Example: update_time=2021-09-14
create_timestring
Timezone: GMT.


Example: create_time=2021-09-14
idstring (uuid)
A unique identifier generated by the Ocamba platform.


Example: id=c7db9321-dc48-43f1-b32d-a45a4991879a
detailsstring
Additional information about an order.


Example: details=Ocamba Push Startup Plan
amountnumber
Order price.


Example: amount=11.99
currency_codestring
Three-letter, uppercase currency code.


Example: currency_code=USD
start_timestring
Timezone: GMT.


Example: start_time=2021-11-24
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ order ]
An array of all created items.
Order
Name
Description
amountfloat
Order price.


Example: 10.99
app_idstring
A unique app identifier generated by the Ocamba platform.


Example: 1003
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1234567
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
currency_codestring
Three-letter, uppercase currency code.


Example: USD
detailsstring
Additional information about an order.


Example: Ocamba Push Startup Plan (Monthly)
idstring (uuid)
A unique identifier generated by the Ocamba platform.


Example: 37ca408f-59d8-4910-bcb0-54dad2641c61
start_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
totalinteger
A total number of items.


Example: 209
tip
1 Searchable field is details.
2 Sortable fields are: amount, currency_code, start_date, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 209,
    "items": [
        {
            "id": "c7db9321-dc48-43f1-b32d-a45a4991879a",
            "company_id": "6197120",
            "app_id": "1003",
            "details": "Ocamba Push Startup Plan (Monthly)",
            "amount": 11.99,
            "currency_code": "USD",
            "start_time": "2021-11-24 10:23:55",
            "create_time": "2021-11-24 10:23:55",
            "update_time": "2021-11-24 10:23:55"
        },
        {
            "id": "f6082c6e-a535-4591-831a-0ac23d08d7f3",
            "company_id": "6197120",
            "app_id": "1003",
            "details": "Ocamba Push Business Plan (Monthly)",
            "amount": 119.99,
            "currency_code": "USD",
            "start_time": "2021-11-24 08:30:18",
            "create_time": "2021-11-24 08:30:18",
            "update_time": "2021-11-24 08:30:18"
        },
        {
            "id": "6363e70f-baca-4a1f-b0d3-82b5628048ed",
            "company_id": "6197120",
            "app_id": "1003",
            "details": "Ocamba Push Startup Plan (Monthly)",
            "amount": 11.99,
            "currency_code": "USD",
            "start_time": "2021-11-22 12:13:32",
            "create_time": "2021-11-22 12:13:32",
            "update_time": "2021-11-22 12:13:32"
        }
    ]
}

{
  "total": 209,
  "items": [
    {
      "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
      "company_id": "1234567",
      "app_id": "1003",
      "details": "Ocamba Push Startup Plan (Monthly)",
      "amount": 10.99,
      "currency_code": "USD",
      "start_time": "2021-07-30 12:50:13",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}