Get history of sales order

GET

/merchants/{merchantCode}/orders/{orderNumber}/history

const url = 'https://order.shopgate.io/v1/merchants/example/orders/example/history';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://order.shopgate.io/v1/merchants/example/orders/example/history

Parameters

Path Parameters

merchantCode

required

string

Unique merchant code which represents the unique “merchant account”.

orderNumber

required

string

Unique order number

Query Parameters

filters

string format: json

Filters as json string to be applied. Available filter is type.

sort

string

Sorting of order history.

Responses

200

Returns the history

application/json

object

history

Array

object

type

string

Allowed values: orderCreated orderStatusUpdated orderLineItemQuantityChanged orderCommentAdded orderCommentUpdated orderCommentDeleted

number

details

string

entityId

Id of the subentity which the history entry belongs to

number

newValue

object

oldValue

object

createDate

string format: date-time

user

object

name

string

Example

{
  "history": [
    {
      "type": "orderStatusUpdated",
      "id": 468,
      "details": "string",
      "entityId": 0,
      "newValue": {
        "status": "checkedIn"
      },
      "oldValue": {
        "status": "ready"
      },
      "createDate": "2021-12-16T16:31:47.118Z",
      "user": {
        "name": "Max Muster",
        "id": "237e228f-c1d0-4bb7-898d-14a5aa1ea955"
      }
    }
  ]
}

404

Sales order not found

application/json

default

Unexpected error

application/json

object

code

Machine readable error code

string

message

required

Human readable error code

string

Example

{
  "code": "internal.database",
  "message": "Internal Database Error"
}