Orders
Supported order attributes:
Attribute | Type | Description |
---|---|---|
id |
number | Unique identifier of the order. |
deal_id |
string | Id of the deal the order is associated to. |
discount |
number | Discount on the whole order in percents. |
created_at |
string | Date and time that the order was created in UTC (ISO8601 format). |
Endpoints
Stream Order
Read the stream of order events.
See theFirehose Overviewarticle for more details on request and response formats and parameters.
Action
GET /v3/orders/stream
Examples
Read the stream of order events
GET /v3/orders/stream?position=tail
Accept: application/json
Authorization: Bearer $ACCESS_TOKEN
User-Agent: $CLIENT_NAME
HTTP/1.1200OK
Content-Type:application/json
{
"items":[
{
"data":{
"discount":0,
"created_at":"2017-06-21T08:06:02Z",
"id":9784250,
"deal_id":38695981
},
"meta":{
"event_cause":"interaction",
"sequence":1,
"event_id":"cJJb6uhWTc2KHhKHI6U07w",
"event_type":"created",
"type":"order",
"event_time":"2017-06-21T08:06:02Z"
}
}
],
"meta":{
"links":{
"next":"https://api.getbase.com/v3/orders/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="
},
"position":"ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==",
"top":false
}
}