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",
  "statusLocalizeInfos": {
    "title": "In progress"
  },
  "formIdentifier": "orderForm",
  "formData": [
    {
      "marker": "order_name",
      "type": "string",
      "value": "Ivan"
    }
  ],
  "attributeSetIdentifier": "order_form",
  "paymentStrategy": "once",
  "totalSum": "51",
  "totalSumRaw": "51",
  "currency": "usd",
  "paymentAccountIdentifier": "stripe",
  "paymentAccountLocalizeInfos": {
    "title": "Stripe"
  },
  "products": [
    {
      "id": 2954,
      "title": "Box",
      "sku": null,
      "previewImage": null,
      "price": 51,
      "quantity": 1,
      "isGift": false
    }
  ],
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a19RuP9hh4gGmaSOQwb57OBpnypIifa0FDnGhYe7od5XkRXRUpYXUKDRtm#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl",
  "discountConfig": {
    "orderDiscounts": [],
    "productDiscounts": [],
    "coupon": null,
    "settings": {
      "allowStacking": false,
      "maxDiscountValue": null,
      "allowGiftStacking": false
    },
    "additionalDiscountsMarkers": [],
    "totalRaw": 51,
    "totalSumWithDiscount": 51,
    "excludedGiftProductIds": [],
    "bonus": null,
    "bonusApplied": 0,
    "totalDue": 51
  },
  "isPartial": false,
  "isCompleted": false,
  "split": {
    "completed": false,
    "partial": false,
    "stages": [
      {
        "marker": "default",
        "sessionId": null,
        "productId": 2954,
        "title": "Default",
        "value": 51,
        "status": "planned"
      }
    ]
  }
}

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"
  }
]

formData.marker: string
Marcador do campo do formulário.
exemplo: "name_1"

formData.type: string
Tipo de valor.
exemplo: "string"

formData.value: string
Valor.
exemplo: "Nome"

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: ILocalizeInfo
Nome da conta de pagamento considerando a localização.
exemplo:

{
  "title": "Cash"
}

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

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

products.id: number
ID do produto.
exemplo: 2957

products.quantity: number
Quantidade do produto.
exemplo: 1

products.title: string
Título do produto.
exemplo: "Cosmo"

products.sku: string | null
SKU do produto.
exemplo: "SKU"

products.previewImage: IPicture | null
Imagem de pré-visualização do produto.
exemplo:

{
  "filename": "image.jpg",
  "downloadLink": "https://example.com/image.jpg",
  "size": 102400,
  "previewLink": "https://example.com/image-preview.jpg"
}

previewImage.filename: string
O nome do arquivo.
exemplo: "image.jpg"

previewImage.downloadLink: string
O link da URL para baixar a imagem.
exemplo: "https://example.com/image.jpg"

previewImage.size: number
O tamanho da imagem em bytes.
exemplo: 102400

previewImage.previewLink: string
O link da URL para visualizar a imagem.
exemplo: "https://example.com/image-preview.jpg"

products.price: number
Preço do produto.
exemplo: 150

products.isGift: boolean
Se o produto é um presente.
exemplo: false

paymentUrl: string | null
Link de pagamento.
exemplo: "https://example.com/pay/123"

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

statusLocalizeInfos: ILocalizeInfo
Nome do status localizado.

---