Pular para o conteúdo
platform
PT EN

Referência da API · Pedidos · Gestão loja

Buscar Detalhes do Pedido - Loja

Método
GET
Rota
/partnerOrders/:id
URL base
https://ws.autorei.net
Parâmetros de rota
:id
Token
Exige token Bearer
Testar no Postman

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Devolve o pedido inteiro: valores, cliente, pagamentos, entregas com os produtos, e o histórico de status.

O id da rota é o do pedido do parceiro (partnerOrderId), o campo id da listagem, não o orderId. Confundir os dois é o erro mais comum desta família de rotas.

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
id integer Sim Id do pedido do parceiro (partnerOrderId), o campo id da listagem.

Resposta · 200

O payload é extenso. A tabela abaixo traz os blocos de topo; os blocos condicionais estão na seção seguinte.

Campo Descrição
id Id do pedido do parceiro.
orderId Id do pedido do cliente, o pedido "pai".
status Status atual.
dateCreated · lastUpdated Criação e última alteração, em UTC.
subTotal · freightTotal · total Valores em número.
subTotalFormats · freightTotalFormats · totalFormats O mesmo valor formatado, em value ("35,91") e mask ("R$ 35,91").
taxes Impostos do pedido: taxPurpose, taxPurposeId, st, ipi, icms, pis, cofins, totalTax.
approvalWorkflow · workflowIsApproved · approvalCredit · approvalLevels Alçada de aprovação do pedido: se ele passa por alçada, se já foi aprovado, e os níveis configurados.
invoiceNote Observação da nota fiscal.
leadTimeByRequestDone Indica que os prazos sob consulta do pedido já foram preenchidos.
order Origem do pedido: origin, originStoreName, originStoreId, originStoreSubdomain, originStorePartnerId, drivenPrice, manualPrice.
seller Parceiro fornecedor: id, name, document.
customer Cliente: id, name, contactName, email, phone, type, document, stateRegistration, optinTracking, trackingPhone, dateCreated, registrationAddress e customerAttributes[]. Veja Dados do cliente.
payments[] Pagamentos: id, paymentType, gateway, paymentInstallmentsValue, paymentInstallments.
deliveries[] Entregas. Cada uma com address, freight e products[], veja O bloco de entregas.
orderStatusLogs[] Histórico de status: status e date, na ordem em que aconteceram.
attendant · seller Atendente e vendedor responsáveis.
whoCreatedPreOrder · whoSelectedPayment Quem criou o pré-pedido e quem escolheu o pagamento: client ou attendant.
commissionAssignedAttendantId · commissionAssignedAttendantCode · commissionAssignedAttendantDoc Atendente a quem a comissão foi atribuída.
totalMarginAfterDiscountPercentage · markup Margem e markup do pedido.
customCartId · cartTypeName · cartTypeExternalId Carrinho personalizado que originou o pedido, quando houve um.
paymentPartnerReceiver[] Divisão do pagamento entre os participantes: participant, name, typeReceiver, paymentFees, splitedBy, splitedPercentage, splitedValue, value.

O bloco de entregas

Cada item de deliveries[] traz três partes:

Parte Conteúdo
address Endereço de entrega: id, name, street, number, quarter, city, state, zipcode, deliveryAddressCode, addressType.
freight Frete: value e valueFormats, name, type, freightTime, packingTime, realValue e realValueFormats, realName, realType, e os identificadores da transportadora quando ela é integrada.
products[] Os itens da entrega.

Cada produto de products[] traz: id (id do SKU) · partnerOrderLineId (id da linha do pedido) · name · mfrPartCode · partnerPartCode · partnerInternalPartCode · composition · quantity, realQuantity e virtualQuantity · price, stockPrice, realSalePrice, totalCost, netCost e os respectivos *Formats · leadTime e isLeadTimeByRequest · marginAfterDiscountPercentage, interestRate, anticipationRate, drivenPrice · warehouse (id, name, zipcode) · brand (id, name) · categoryId e categoryName · whoAddedItemToCart · customKey · specialRules · needsAgronomicRecipe · e os campos de unidade de venda (salesUnitOfMeasurement, salePriceByUnitOfMeasurement, unitaryQuantityInSalesUnitOfMeasurement, totalQuantityInSalesUnitOfMeasurement).

Blocos condicionais

Aparecem só quando o pedido tem o dado correspondente: discounts · replicaOrdersCreated · workflowItemsAttributes · orderWorkflowReason · commodityExchange · orderDeliveryAttendantDiscount · supplierOrderId, supplierInvoiceNumber, supplierInvoiceSerie, supplierInvoiceKey e supplierInvoiceDate · orderName · partnerOrderCashBackInfo · orderCustomerThirdPartyReferral · couponCode · customAttributes · orderDocuments · fiscalNotes · os atributos external* · poTax · paymentDateVpvf.

Regras de negócio

Dados do cliente

Parte dos dados do cliente pode vir mascarada ou omitida, conforme o contrato de marketplace da loja, o vínculo de filial e a configuração de restrição de dados da loja de origem. O bloco customer existe sempre; o que varia é o preenchimento.

Erros

Código Quando
404 O pedido não existe ou não está no seu escopo: {"status":"NOT_FOUND","message":"Pedido com id X não encontrado"}. O mesmo corpo nos dois casos.
401 Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request GET 'https://ws.autorei.net/partnerOrders/:id' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: pedido com pagamento aprovado

{
  "attendant": null,
  "orderId": 900100,
  "id": 900201,
  "status": "PAYMENT_APPROVED",
  "approvalWorkflow": false,
  "workflowIsApproved": false,
  "approvalCredit": null,
  "subTotal": 35.91,
  "subTotalFormats": {
    "value": "35,91",
    "mask": "R$ 35,91"
  },
  "taxes": {
    "taxPurpose": null,
    "taxPurposeId": null,
    "st": 0,
    "ipi": 0,
    "icms": 0,
    "pis": 0,
    "cofins": 0,
    "totalTax": 0
  },
  "freightTotal": 45.73,
  "freightTotalFormats": {
    "value": "45,73",
    "mask": "R$ 45,73"
  },
  "total": 81.64,
  "totalFormats": {
    "value": "81,64",
    "mask": "R$ 81,64"
  },
  "dateCreated": "2026-09-01T13:26:05Z",
  "lastUpdated": "2026-09-01T13:27:26Z",
  "invoiceNote": null,
  "leadTimeByRequestDone": true,
  "order": {
    "origin": "SHOP",
    "originStoreName": "Loja Exemplo",
    "originStoreId": 4210,
    "originStoreSubdomain": "lojaexemplo",
    "originStorePartnerId": 5050,
    "drivenPrice": false,
    "manualPrice": false
  },
  "seller": {
    "id": 5050,
    "name": "Loja Exemplo",
    "document": "30.424.972/0001-74"
  },
  "customer": {
    "id": 700101,
    "name": "Ana Paula Ribeiro",
    "contactName": "Ana Paula Ribeiro",
    "email": "ana.ribeiro@exemplo.com.br",
    "phone": "(11) 98765-4321",
    "type": "pf",
    "document": "700.413.648-56",
    "stateRegistration": null,
    "optinTracking": null,
    "trackingPhone": null,
    "dateCreated": "2026-08-20T09:15:00Z",
    "registrationAddress": {
      "street": "Avenida Paulista",
      "number": "1578",
      "quarter": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "zipcode": "01310-100",
      "farmerStateRegistration": null
    },
    "customerAttributes": [
      {
        "name": "OPTIN_NEWSLETTER",
        "value": "true"
      }
    ]
  },
  "payments": [
    {
      "id": 4490201,
      "paymentType": "BANK_SLIP",
      "gateway": "GATEWAY_DE_PAGAMENTO",
      "paymentInstallmentsValue": 81.64,
      "paymentInstallments": 1
    }
  ],
  "deliveries": [
    {
      "address": {
        "id": 4470701,
        "name": "Endereço de entrega",
        "street": "Avenida Paulista",
        "number": "1578",
        "quarter": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "zipcode": "01310-100",
        "deliveryAddressCode": null,
        "addressType": "RESIDENTIAL"
      },
      "freight": {
        "value": 45.73,
        "valueFormats": {
          "value": "45,73",
          "mask": "R$ 45,73"
        },
        "name": "CORREIO - SEDEX",
        "type": "INTELIPOST",
        "freightTime": 4,
        "packingTime": 0,
        "realValue": 45.73,
        "realValueFormats": {
          "value": "45,73",
          "mask": "R$ 45,73"
        },
        "realName": "CORREIO - SEDEX",
        "realType": "INTELIPOST",
        "intelipostQuoteId": "202956238407743",
        "intelipostDeliveryMethodId": "2",
        "intelipostDeliveryMethodExternalId": "94"
      },
      "products": [
        {
          "id": 500101,
          "name": "Produto Exemplo A",
          "mfrPartCode": "FE-500101",
          "composition": "UNITARY",
          "virtualQuantity": 0,
          "realQuantity": 1,
          "quantity": 1,
          "price": 35.91,
          "priceFormats": {
            "value": "35,91",
            "mask": "R$ 35,91"
          },
          "leadTime": 0,
          "partnerOrderLineId": 4490101,
          "isLeadTimeByRequest": false,
          "stockPrice": 39.9,
          "stockPriceFormats": {
            "value": "39,90",
            "mask": "R$ 39,90"
          },
          "totalCost": 52.15,
          "totalCostFormats": {
            "value": "52,15",
            "mask": "R$ 52,15"
          },
          "netCost": 52.15,
          "netCostFormats": {
            "value": "52,15",
            "mask": "R$ 52,15"
          },
          "marginAfterDiscountPercentage": null,
          "interestRate": null,
          "anticipationRate": null,
          "realSalePrice": 35.91,
          "realSalePriceFormats": {
            "value": "35,91",
            "mask": "R$ 35,91"
          },
          "drivenPrice": false,
          "partnerPartCode": "SKU-A-001",
          "partnerInternalPartCode": null,
          "warehouse": {
            "id": 1001,
            "name": "Depósito Central",
            "zipcode": "01310-100"
          },
          "brand": {
            "id": 4460101,
            "name": "Fabricante Exemplo"
          },
          "specialRules": {},
          "needsAgronomicRecipe": "false",
          "salesUnitOfMeasurement": null,
          "salePriceByUnitOfMeasurement": null,
          "unitaryQuantityInSalesUnitOfMeasurement": null,
          "totalQuantityInSalesUnitOfMeasurement": null,
          "whoAddedItemToCart": "client",
          "customKey": null,
          "categoryId": 31519,
          "categoryName": "Categoria Exemplo"
        }
      ]
    }
  ],
  "paymentPartnerReceiver": [
    {
      "participant": "marketplace",
      "name": "Loja Exemplo",
      "typeReceiver": "PRIMARY",
      "paymentFees": "true",
      "splitedBy": "TOTAL",
      "splitedPercentage": 100,
      "splitedValue": "81,64",
      "value": "81,64"
    }
  ],
  "orderStatusLogs": [
    {
      "status": "PAYMENT_APPROVED",
      "date": "2026-09-02T11:12:40Z"
    }
  ],
  "totalMarginAfterDiscountPercentage": null,
  "markup": null,
  "whoCreatedPreOrder": "client",
  "whoSelectedPayment": "client",
  "commissionAssignedAttendantId": null,
  "commissionAssignedAttendantCode": null,
  "commissionAssignedAttendantDoc": null,
  "approvalLevels": [],
  "customCartId": null,
  "cartTypeName": null,
  "cartTypeExternalId": null
}

Usado em

Endpoints relacionados

← Ver o grupo: Pedidos

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.