getAllOrdersByMarker

Obtendo todos os pedidos do objeto de armazenamento de pedidos criado pelo usuário 🔐 Este método requer autorização.

Orders.getAllOrdersByMarker(marker, langCode, offset, limit)

const value = await Orders.getAllOrdersByMarker('my-order')

Esquema

marker:* string
Identificador textual do objeto de armazenamento de pedidos
exemplo: my-order

langCode: string
Campo de idioma opcional
exemplo: en_US

offset: number
Parâmetro de deslocamento. Padrão 0
exemplo: 0

limit: number
Parâmetro de limite. Padrão 30
exemplo: 30

Este método obtém todos os objetos de armazenamento de pedidos pelo marcador. O método adicionará o idioma padrão ao corpo da solicitação. Se você quiser mudar o idioma, basta passá-lo como o segundo argumento.

Exemplo de retorno:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "statusIdentifier": "inprogress",
      "formIdentifier": "order-form",
      "formData": [
        {
          "marker": "name_1",
          "type": "string",
          "value": "Nome"
        }
      ],
      "products": [
        {
          "id": 1,
          "title": "Piso Laminado 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": {"title": "Conta 1"
      },
      "isHistory": true
    }
  ]

}

Esquema

total: number
total de registros encontrados
exemplo: 100

statusIdentifier: string
identificador textual do status do pedido
exemplo: inprogress

formIdentifier: string
identificador textual do status do formulário
exemplo: order-form

formData FormDataType
dados enviados pelo formulário vinculado ao armazenamento de pedidos
exemplo:

[
  {
    "marker": "name_1",
    "value": "Nome"
  }
]

products Record<string, string | any>[]
array de produtos adicionados ao pedido

totalSum string
valor total do pedido
exemplo: 12.00

currency string
moeda utilizada para pagar o pedido
exemplo: USD

createdDate string
data em que o pedido foi criado
exemplo: 2023-01-01 12:12

price number
preço do produto por unidade (no momento do pedido)
exemplo: 20.00

paymentAccountIdentifier string
identificador textual para o pagamento do pedido
exemplo: payment-1

paymentAccountLocalizeInfos CommonLocalizeInfos
nome da conta de pagamento considerando a localização
exemplo:

{
  "title": "Conta 1"
}

isHistory boolean
indica que o pedido foi salvo no histórico de pedidos
exemplo: true