getOrderByMarker

Obtém um objeto de armazenamento de pedido por marcador. 🔐 Este método requer autorização.

Descrição

Este método recupera um objeto de armazenamento de pedido por marcador. Ele retorna uma Promise que resolve para um objeto IOrdersEntity.

Orders.getOrderByMarker(

marker, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador do objeto de pedido
exemplo: "order_storage_1"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

const response = await Orders.getOrderByMarker('my-order');

Exemplo com atributos

const response = await Orders.getOrderByMarker('my-order', 'en_US');

Exemplo de resposta

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

Esquema de resposta

Esquema: IOrdersEntity

id: number
Identificador do objeto.
exemplo: 1

localizeInfos: ILocalizeInfo
Nome considerando a localização.
exemplo:

{
  "title": "Dinheiro"
}

position: number | null
Posição no armazenamento de pedidos.
exemplo: 1

identifier: string
Identificador textual para o campo do registro.
exemplo: "order_storage_1"

formIdentifier: string
Identificador textual para o formulário usado pelo armazenamento de pedidos.
exemplo: "bar-orders-form"

generalTypeId: number | null
Identificador do tipo.
exemplo: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Array de identificadores textuais das contas de pagamento usadas pelo armazenamento de pedidos.
exemplo:

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

---