Thanks for being patient while we implement your feedback to improve the developer experience.

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

    If the message is flagged.

  • status in query - string

    Status of the order message.

  • page in query - number

    The page to return in the response.

  • limit in query - number

    Number of results to return.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/orders/[order_id]/messages' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

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

[
  {
    "id": 2,
    "order_id": 181,
    "staff_id": 1,
    "customer_id": 11,
    "type": "admin",
    "subject": "Re: Order #181",
    "message": "Thank you again!",
    "status": "unread",
    "is_flagged": false,
    "date_created": "Wed, 26 Sep 2018 15:52:03 +0000",
    "customer": {}
  }
]