getOrderById

Name: OneEntry SDK
Author: OneEntry

Obtenha um dos pedidos do usuário pelo id. 🔐 Este método requer autorização.

Descrição

Busca um dos pedidos do usuário autenticado apenas pelo id, sem o marcador do armazenamento. Resolve para um IOrderByMarkerEntity, a mesma entidade retornada por getOrderByMarkerAndId.

.getOrderById(
,
);

Esquema de parâmetros

Schema

id(required): number
ID do pedido.
exemplo: 12345

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

Quando usá-lo em vez de getOrderByMarkerAndId

getOrderByMarkerAndId precisa do marcador do armazenamento e do id. Quando o id vem de fora do seu app, geralmente é o marcador que você não tem: a URL de retorno de um provedor de pagamento, um link em uma notificação, um número de pedido que o cliente dita por telefone. Use este método nesses casos.

Exemplos

Exemplo mínimo

const response = await Orders.getOrderById(205);

Com um código de idioma

const response = await Orders.getOrderById(205, 'en_US');

Exemplo de resposta

{
  "id": 205,
  "storageId": 1,
  "createdDate": "2025-07-18T05:51:09.924Z",
  "statusIdentifier": "inProgress",
  "statusLocalizeInfos": {
    "title": "In progress"
  },
  "fulfillmentStatusIdentifier": null,
  "fulfillmentStatusLocalizeInfos": null,
  "paymentStatusIdentifier": null,
  "paymentStatusLocalizeInfos": null,
  "formIdentifier": "orderForm",
  "formData": [
    {
      "marker": "order_name",
      "type": "string",
      "value": "John"
    }
  ],
  "attributeSetIdentifier": "order_form",
  "paymentStrategy": "once",
  "totalSum": "51",
  "totalSumRaw": "51",
  "currency": "usd",
  "paymentAccountIdentifier": "stripe",
  "paymentAccountLocalizeInfos": {
    "title": "Stripe"
  },
  "products": [
    {
      "id": 2954,
      "title": "Box",
      "sku": null,
      "previewImage": [
        {
          "size": 742690,
          "filename": "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
          "contentType": "image/jpeg",
          "previewLink": {
            "default": [
              "data:image/webp;base64,UklGRmwAAABXRUJQVlA4IGAAAADQAQCdASoQABAABUB8JbACdACZZ3P8AAD+wGsUXBs/r069WpdrcuaTNfVxqWIetuaIdIvOMkSp9iJRxE+KhA2YHbrVehhMRj/j5+DUdjWn1v5YtZ7vw0IgPi9R5vkAAAA=",
              "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.preview.default.jpeg"
            ]
          },
          "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
          "defaultPreview": "default"
        }
      ],
      "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
ID do objeto.
exemplo: 125

storageId: number
ID do armazenamento de pedidos.
exemplo: 1

createdDate: string
Data de criação do pedido.
exemplo: "2023-10-01T12:00:00Z"

statusIdentifier: string
Marcador do status do pedido.
exemplo: "order-status-1"

formIdentifier: string
Marcador do formulário.
exemplo: "bar-orders-form"

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

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

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

formData.type: string
Tipo do valor do campo, por exemplo "string".
exemplo: "string"

formData.value: string
Valor do campo.
exemplo: "Name"

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

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

totalSumRaw: string
Valor total bruto do pedido com precisão completa.
exemplo: "100.00"

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

paymentAccountIdentifier: string | null
Marcador da conta de pagamento.
exemplo: "payment-1"

paymentAccountLocalizeInfos: ILocalizeInfo
Nome localizado da conta de pagamento.
exemplo:

{
  "title": "Cash"
}

products: IOrderProducts[]
Produtos do 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évia do produto.
exemplo:

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

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

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

paymentUrl: string | null
URL da página de pagamento.
exemplo: "https://example.com/pay/123"

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

isPartial: boolean | null
Se o pedido está parcialmente pago; null em pedidos antigos em que isso não era registrado.
exemplo: false

paymentStrategy: string
Estratégia de pagamento do pedido.
exemplo: "once"

statusLocalizeInfos: ILocalizeInfo
Nome localizado do status.

fulfillmentStatusIdentifier: string | null
Marcador do status de atendimento (entrega); null enquanto nenhum status de atendimento é atribuído.
exemplo: "shipped"

fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Nome localizado do status de atendimento; null enquanto nenhum status de atendimento é atribuído.

paymentStatusIdentifier: string | null
Marcador do status de pagamento; null enquanto nenhum status de pagamento é atribuído.
exemplo: "inProgress-payment"

paymentStatusLocalizeInfos: ILocalizeInfo | null
Nome localizado do status de pagamento; null enquanto nenhum status de pagamento é atribuído.

discountConfig: IOrderDiscountConfig | null
Configuração de desconto resolvida para o pedido: orderDiscounts, productDiscounts, coupon, settings, bonus e totais. null em pedidos antigos sem configuração resolvida.

discountConfig.bonus: IOrderDiscountBonus | null
Resultado do cálculo de bônus: null quando os bônus não são usados; omitido quando o pedido não tem contexto de bônus.

discountConfig.coupon: unknown | null
Cupom aplicado, ou null quando nenhum cupom é aplicado.

discountConfig.orderDiscounts: unknown[]
Descontos no nível do pedido que foram encontrados e aplicados.

discountConfig.productDiscounts: unknown[]
Descontos no nível do produto que foram encontrados e aplicados.

discountConfig.settings: IOrderDiscountSettings
Configurações de acumulação e limite usadas no cálculo.

discountConfig.additionalDiscountsMarkers: string[]
Marcadores de descontos adicionais solicitados pelo cliente. Omitidos nas respostas de prévia.

discountConfig.bonusApplied: number
Valor de bônus aplicado ao pedido. Omitido nas respostas de prévia.
exemplo: 0

discountConfig.excludedGiftProductIds: string[]
IDs de produtos excluídos da seleção de brindes. Omitidos nas respostas de prévia.

discountConfig.totalDue: number
Valor total devido após descontos e bônus (omitido nas respostas de prévia).
exemplo: 300

discountConfig.totalRaw: number
Valor total antes dos descontos (omitido nas respostas de prévia).
exemplo: 300

discountConfig.totalSumWithDiscount: number
Valor total após os descontos, mas antes dos bônus (omitido nas respostas de prévia).
exemplo: 300

split: IOrderSplit
Configuração de pagamento parcelado (em etapas); presente no endpoint de pedido por ID.

split.completed: boolean
Se todas as etapas do pagamento parcelado foram concluídas.
exemplo: false

split.partial: boolean
Se o parcelamento está parcialmente pago.
exemplo: false

split.stages: IOrderSplitStage[]
Lista ordenada das etapas do pagamento parcelado.

distance: number
Distância do cosseno até a consulta. Retornada em todos os itens pelo endpoint de busca semântica (vetorial).
exemplo: 0.12

Descrição​

Esquema de parâmetros​

Quando usá-lo em vez de getOrderByMarkerAndId​

Exemplos​

Exemplo mínimo​

Com um código de idioma​

Exemplo de resposta​

Esquema de resposta​