Skip to main content

Order Events

GET 
/orders/:id/events

Get status events for an order. Status events are only stored for one week after the order is placed.

Request​

Path Parameters

    id stringrequired

    REQUIRED. The ID assigned to the Order.

Query Parameters

    limit integer

    Default value: 10

    Number of items to return in the response list.

    filter string

    Filter results that match values in the given key separated by a colon. These are not exact matches, so filtering on a value of pet:cat will return cat along with caterpillar pets. Filter parameters may be repeated if multiple filters are desired, but a given field can only be queried once because all filters will be logically ANDed.

    sort string

    Possible values: [asc, desc]

    Default value: desc

    Sort order, desc for descending chronological order of creation date (latest first), asc for ascending order.

    starting_after string

    The token (base64 string) next_page_token returned in the previous page of results. This is used to fetch the next page of results when the sort order is asc.

    ending_before string

    The token (base64 string) next_page_token returned in the previous page of results. This is used to fetch the next page of results when the sort order is desc.

Responses​

OK

Schema
    data objectrequired
    events object[]
  • Array [
    • date_created string
    order_id string
    pipeline_id string
    message string
    event_code string
  • ]
    • links objectrequired
    request string
    next_page string
    request_timestamp stringrequired
    response_timestamp stringrequired
    request_duration numberrequired
    next_page_token string
Loading...