Docs
Management API
Order Messages

Order Messages

Get Order Messages

GET /orders/{order_id}/messages

Request

Gets the messages associated with an order.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • min_id in query - integer

    The minimum order ID.

  • max_id in query - integer

    The maximum order ID.

  • customer_id in query - integer

    Customer ID.

  • min_date_created in query - string

    Minimum date the order was created in RFC-2822 or ISO-8601.

    RFC-2822: Thu, 20 Apr 2017 11:32:00 -0400

    ISO-8601: 2017-04-20T11:32:00.000-04:00

  • max_date_created in query - string

    Maximum date the order was created in RFC-2822 or ISO-8601.

    RFC-2822: Thu, 20 Apr 2017 11:32:00 -0400

    ISO-8601: 2017-04-20T11:32:00.000-04:00

  • is_flagged in query - boolean

    Whether the message is flagged.

  • status in query - string

    Status of the order message.

    Allowed: read | unread

  • page in query - number

    The page to return in the response.

  • limit in query - number

    Number of results to return.

example

Response

Body

array | application/json
  • id
    integer

  • order_id
    integer

  • staff_id
    integer

  • customer_id
    integer

  • type
    string

  • subject
    string

  • message
    string

  • status
    string

  • is_flagged
    boolean

  • date_created
    string

  • customer
    object

response

Did you find what you were looking for?