getAllStatusesByStorageMarker

Getting all order statuses available for a specific order storage by its marker.

Description

This method retrieves all order status objects associated with a specific order storage, identified by its textual marker. It returns a Promise that resolves to an array of IOrderStatusEntity objects.

Orders.getAllStatusesByStorageMarker(

marker*, langCode, offset, limit

);

Parameters schema

Schema

marker(required): string
Textual identifier of the order storage object
example: "order_storage_1"

langCode: string
Language code. Default: "en_US"
example: "en_US"

offset: number
Offset parameter. Default: 0
example: 0

limit: number
Limit parameter. Default: 30
example: 30

Examples

Minimal example

const response = await Orders.getAllStatusesByStorageMarker('my_order');

Example with attributes

const response = await Orders.getAllStatusesByStorageMarker('my_order', 'en_US');

Example response

[
  {
    "id": 9,
    "identifier": "completed-payment",
    "localizeInfos": {
      "title": "Completed"
    },
    "isDefault": false,
    "isCancelFinal": false,
    "isFinalSuccess": true,
    "axis": "payment",
    "position": 1,
    "isUsed": false,
    "isMapped": true
  },
  {
    "id": 7,
    "identifier": "inProgress-payment",
    "localizeInfos": {
      "title": "In progress"
    },
    "isDefault": true,
    "isCancelFinal": false,
    "isFinalSuccess": false,
    "axis": "payment",
    "position": 2,
    "isUsed": true,
    "isMapped": true
  },
  {
    "id": 11,
    "identifier": "expired-payment",
    "localizeInfos": {
      "title": "Expired"
    },
    "isDefault": false,
    "isCancelFinal": false,
    "isFinalSuccess": false,
    "axis": "payment",
    "position": 3,
    "isUsed": false,
    "isMapped": true
  },
  "..."
]

Response schema

Schema: IOrderStatusEntity[]

id: number
Status identifier.
example: 1

localizeInfos: ILocalizeInfo
Localized information for the status.

identifier: string
Text identifier of the status.
example: "inProgress-payment"

position: number
Position of the status.
example: 1

isUsed: boolean
Whether the status is in use.
example: true

isDefault: boolean
Whether the status is the default status.
example: true

axis: string
Status axis (pipeline) the status belongs to.
example: "payment"

isCancelFinal: boolean
Whether the status is a final cancellation status.
example: false

isFinalSuccess: boolean
Whether the status is a final successful status.
example: true

isMapped: boolean
Whether the status is mapped to its axis.
example: true

---