order

Order - Add Note

Changed on

Add an internal or customer-facing note to an order.

post/order/add_note

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/order/add_note
  • Auth
    HTTP bearer

Request body

store_idstring required

Store ID

order_numberstring required

Order number

notestring required

Note text

type'internal' | 'customer_facing'

Note type

Example request

{
  "store_id": "507f1f77bcf86cd799439011"
}

Response

Note added

successboolean required

Whether the operation succeeded

Changes

  • fa53dd949b8eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      api operation id post_order_add_note was added

    • info

      added the new customer_facing enum value to the request property

    • info

      added the new internal enum value to the request property

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 08cd9cfa14ddRevision changes
    • breaking

      added required request body

    • warning

      deleted the query request parameter note

    • warning

      deleted the query request parameter order_number

    • warning

      deleted the query request parameter store_id

    • warning

      deleted the query request parameter type

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status