getOrderByMarkerAndId

Obtendo um pedido por marcador e id do objeto de armazenamento de pedidos criado pelo usuário. 🔐 Este método requer autorização.

Descrição

Este método recupera um objeto de armazenamento de pedidos por marcador e id. Ele retorna uma Promise que resolve para um objeto IOrderByMarkerEntity.

Pedidos.getOrderByMarkerAndId(

marker, id, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
O identificador de texto do objeto de armazenamento de pedidos
exemplo: "order_storage_1"

id(obrigatório): number
ID do objeto de pedido
exemplo: 12345

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

Exemplos

Exemplo mínimo

const response = await Orders.getOrderByMarkerAndId('my-order', 1764);

Exemplo com atributos

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

Exemplo de resposta

{
  "id": 205,
  "storageId": 1,
  "createdDate": "2025-07-18T05:51:09.924Z",
  "statusIdentifier": "inProgress",
  "formIdentifier": "orderForm",
  "formData": [
    {
      "marker": "order_name",
      "type": "string",
      "value": "Ivan"
    }
  ],
  "attributeSetIdentifier": "order_form",
  "totalSum": "50.00",
  "currency": "usd",
  "paymentAccountIdentifier": "stripe",
  "paymentAccountLocalizeInfos": {
    "title": "Stripe"
  },
  "products": [
    {
      "id": 2954,
      "title": "Box",
      "sku": null,
      "previewImage": null,
      "price": 50,
      "quantity": 1
    }
  ],
  "isCompleted": false
}

Esquema de resposta

Esquema: IOrderByMarkerEntity

id: number
Identificador do objeto.
exemplo: 125

storageId: number
Identificador do objeto de armazenamento de pedidos.
exemplo: 1

createdDate: string
Data em que o pedido foi criado.
exemplo: "2023-10-01T12:00:00Z"

statusIdentifier: string
Identificador de texto do status do pedido.
exemplo: "order-status-1"

formIdentifier: string
Identificador de texto do formulário.
exemplo: "bar-orders-form"

formData: IOrdersFormData[]
Dados enviados pelo formulário vinculado ao armazenamento de pedidos.
exemplo:

[
  {
    "marker": "order_name",
    "value": "Ivan",
    "type": "string"
  }
]

attributeSetIdentifier: string | null
Identificador de texto do conjunto de atributos.
exemplo: "attribute-set-1"

totalSum: string
Valor total do pedido.
exemplo: "100.00"

currency: string
Moeda utilizada para pagar o pedido.
exemplo: "USD"

paymentAccountIdentifier: string | null
Identificador textual para o pagamento do pedido.
exemplo: "payment-1"

paymentAccountLocalizeInfos: Record<string, any>
Nome da conta de pagamento considerando a localização.
exemplo:

{
  "en_US": "USD Payment",
  "ru_RU": "Оплата в долларах США"
}

products: IOrderProducts[]
Array de produtos adicionados ao pedido.
exemplo:

[
  {
    "id": 1,
    "name": "Product 1",
    "quantity": 2
  }
]

isCompleted: boolean
Indica que o pedido foi concluído.
exemplo: true

---