Skip to content
platform
EN PT

API reference · Orders · Store Management

Get Order Details - Store

Method
GET
Route
/partnerOrders/:id
Base URL
https://ws.autorei.net
Path parameters
:id
Token
Requires Bearer token
Test in Postman

Opens this request in the public API documentation, the official source of the reference.

Description

Returns the full order: values, customer, payments, deliveries with products, and the status history.

The route id is that of the partner order (partnerOrderId), the id field from the listing — not the orderId. Mixing up the two is the most common mistake with this family of routes.

Path Parameters

Parameter Type Required Description
id integer Yes Id of the partner order (partnerOrderId), the id field from the listing.

Response · 200

The payload is extensive. The table below lists the top-level blocks; the conditional blocks are in the next section.

Field Description
id Partner order id.
orderId Customer order id, the "parent" order.
status Current status.
dateCreated · lastUpdated Creation and last change, in UTC.
subTotal · freightTotal · total Values as numbers.
subTotalFormats · freightTotalFormats · totalFormats The same value, formatted, in value ("35,91") and mask ("R$ 35,91").
taxes Order taxes: taxPurpose, taxPurposeId, st, ipi, icms, pis, cofins, totalTax.
approvalWorkflow · workflowIsApproved · approvalCredit · approvalLevels Order approval tier: whether it goes through an approval tier, whether it has already been approved, and the configured levels.
invoiceNote Invoice (nota fiscal) note.
leadTimeByRequestDone Indicates that the order's on-request lead times have already been filled in.
order Order origin: origin, originStoreName, originStoreId, originStoreSubdomain, originStorePartnerId, drivenPrice, manualPrice.
seller Supplier partner: id, name, document.
customer Customer: id, name, contactName, email, phone, type, document, stateRegistration, optinTracking, trackingPhone, dateCreated, registrationAddress and customerAttributes[]. See Customer data.
payments[] Payments: id, paymentType, gateway, paymentInstallmentsValue, paymentInstallments.
deliveries[] Deliveries. Each one with address, freight and products[] — see The deliveries block.
orderStatusLogs[] Status history: status and date, in the order they happened.
attendant · seller Attendant and sales rep in charge.
whoCreatedPreOrder · whoSelectedPayment Who created the pre-order and who selected the payment: client or attendant.
commissionAssignedAttendantId · commissionAssignedAttendantCode · commissionAssignedAttendantDoc Attendant to whom the commission was assigned.
totalMarginAfterDiscountPercentage · markup Order margin and markup.
customCartId · cartTypeName · cartTypeExternalId Custom cart that originated the order, when there was one.
paymentPartnerReceiver[] Payment split among the participants: participant, name, typeReceiver, paymentFees, splitedBy, splitedPercentage, splitedValue, value.

The deliveries block

Each item of deliveries[] has three parts:

Part Content
address Delivery address: id, name, street, number, quarter, city, state, zipcode, deliveryAddressCode, addressType.
freight Freight: value and valueFormats, name, type, freightTime, packingTime, realValue and realValueFormats, realName, realType, and the carrier identifiers when the carrier is integrated.
products[] The delivery items.

Each product in products[] has: id (SKU id) · partnerOrderLineId (order line id) · name · mfrPartCode · partnerPartCode · partnerInternalPartCode · composition · quantity, realQuantity and virtualQuantity · price, stockPrice, realSalePrice, totalCost, netCost and the respective *Formats · leadTime and isLeadTimeByRequest · marginAfterDiscountPercentage, interestRate, anticipationRate, drivenPrice · warehouse (id, name, zipcode) · brand (id, name) · categoryId and categoryName · whoAddedItemToCart · customKey · specialRules · needsAgronomicRecipe · and the sales unit fields (salesUnitOfMeasurement, salePriceByUnitOfMeasurement, unitaryQuantityInSalesUnitOfMeasurement, totalQuantityInSalesUnitOfMeasurement).

Conditional blocks

They appear only when the order has the corresponding data: discounts · replicaOrdersCreated · workflowItemsAttributes · orderWorkflowReason · commodityExchange · orderDeliveryAttendantDiscount · supplierOrderId, supplierInvoiceNumber, supplierInvoiceSerie, supplierInvoiceKey and supplierInvoiceDate · orderName · partnerOrderCashBackInfo · orderCustomerThirdPartyReferral · couponCode · customAttributes · orderDocuments · fiscalNotes · the external* · poTax · paymentDateVpvf.

Business rules

Customer data

Some of the customer data may come masked or omitted, depending on the store's marketplace contract, the branch link, and the data restriction setting of the origin store. The customer block is always present; what varies is how it is filled in.

Errors

Code When
404 The order does not exist or is not in your scope: {"status":"NOT_FOUND","message":"Pedido com id X não encontrado"}. The same body in both cases.
401 Token missing, malformed, or expired.

Example request

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

Example responses

200Success — order with approved payment

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

Used in

Related endpoints

← See the group: Orders

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.