getOrdersStorageByMarker

Obtenha um armazenamento de pedidos pelo marcador. 🔐 Este método requer autorização.

Descrição

Busca um armazenamento de pedidos pelo marcador. Resolve para um IOrdersEntity.

.getOrdersStorageByMarker(

,

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador do armazenamento de pedidos.
exemplo: "order_storage_1"

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

Exemplos

Exemplo mínimo

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

Exemplo com langCode

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

Exemplo de resposta

{
  "id": 1,
  "localizeInfos": {
    "title": "My order"
  },
  "position": 1,
  "identifier": "my_order",
  "formIdentifier": "orderForm",
  "generalTypeId": 21,
  "paymentAccountIdentifiers": [
    {
      "identifier": "stripe"
    },
    {
      "identifier": "cash"
    },
    {
      "identifier": "paypal"
    }
  ]
}

Esquema de resposta

Esquema: IOrdersEntity

id: number
ID do objeto.
exemplo: 1

localizeInfos: ILocalizeInfo
Nome localizado do armazenamento de pedidos.
exemplo:

{
  "title": "Cash"
}

position: number | null
Posição do armazenamento de pedidos, usada para ordenação.
exemplo: 1

identifier: string
Marcador do armazenamento de pedidos.
exemplo: "order_storage_1"

formIdentifier: string
Marcador do formulário usado pelo armazenamento de pedidos.
exemplo: "bar-orders-form"

generalTypeId: number | null
ID do tipo geral.
exemplo: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Marcadores das contas de pagamento usadas pelo armazenamento de pedidos.
exemplo:

[
  {
    "identifier": "payment-1"
  }
]

paymentAccountIdentifiers.identifier: string
Marcador da conta de pagamento.
exemplo: "payment-1"

---