getOrderByMarkerAndId

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

Orders.getOrderByMarkerAndId(marker, id, langCode)

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

Esquema

marker:* string
O identificador de texto do objeto de armazenamento de pedidos
exemplo: my-order

id:* number
ID do objeto de pedido
exemplo: 1764

langCode: string
Campo de idioma opcional
exemplo: en_US

Este método recupera um objeto de armazenamento de pedidos por marcador e id.

Exemplo de retorno:

{
  "id": 1764,
  "statusIdentifier": "inprogress",
  "formIdentifier": "order-form",
  "formData": [
    {
      "marker": "name_1",
      "type": "string",
      "value": "Nome"
    }
  ],
  "products": [
    {
      "id": 1,
      "title": "Laminado Floorwood Maxima, 9811 Carvalho Mistral",
      "sku": null,
      "price": "1.00",
      "quantity": 10,
      "previewImage": [
        {
          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
          "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
          "size": 296391,
          "previewLink": ""
        }
      ]
    }
  ],
  "totalSum": "12.00",
  "currency": "USD",
  "createdDate": "2023-01-01 12:12",
  "paymentAccountIdentifier": "payment-1",
  "paymentAccountLocalizeInfos": {
    "en_US": {
      "title": "Conta 1"
    }
  },
  "isHistory": true
}

Esquema

id: number
identificador do objeto
exemplo: 1764

localizeInfos: Record<string, any>
descrição em json do objeto de dados da página principal levando em conta o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Conteúdo para catálogo",
    "htmlContent": "<b>Conteúdo para catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

identifier string
identificador textual para o campo do registro
exemplo: catalog

generalTypeId number
identificador do tipo
exemplo: 4

formIdentifier string
identificador textual para o formulário usado pelo armazenamento de pedidos
exemplo: catalog-form

paymentAccountIdentifiers Array<{identifier:string}
array de identificadores textuais das contas de pagamento usadas pelo armazenamento de pedidos
exemplo:

[
  {
    "identifier": "p1"
  }
]