View Order

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

Retrieves the details of an Order if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstring (uuid)required
A unique identifier generated by the Ocamba platform.


Example: c7db9321-dc48-43f1-b32d-a45a4991879a
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

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: 1
tip
1 If you don't know the order id, list the orders to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "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"
        }
    ]
}

{
  "total": 1,
  "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"
    }
  ]
}