Consultar Pedido

Nesta seção explicamos sobre os recursos que permite consulta os dados no pedido no Seller

Quando for necessário consultar a situação do pedido no Seller, será possível efetuar a ação através deste endpoint que retornará todos os dados enviados pelo Marketplace, acrescentando o status atual do pedido e as informações de Faturamento, Despacho e Entregue caso o pedido já tenha avançado.

Este endpoint deverá ser utilizado pontualmente caso necessário pois já receberam as notificações através dos endpoints informados anteriormente.

Endpoint

Get Order

GET https://{environmentSeller}/pvt/orders/{orderId}

Path Parameters

Name	Type	Description
{environmentSeller}*	string	URL da API do Seller
{orderId}*	string	ID do Pedido do Seller

Headers

Name	Type	Description
X-VTEX-API-AppKey*	string	{{appKey}}
X-VTEX-API-AppToken*	string	{{appToken}}
Accept*	string	application/json
Content-Type*	string	application/json

200: OK Se a notificação for realizada com sucesso

Consulte o Swagger API

400: Bad Request Se a requisição não atender os requisitos mínimos

{
  "errorCode": "string",
  "message": "string"
}

401: Unauthorized Se a requisição não for autenticada

429: Too Many Requests Muitos requests simultâneos

500: Internal Server Error Se ocorrer um erro no servidor

{
  "errorCode": "string",
  "message": "string"
}

403: Forbidden As credenciais não estão ativas para acessar o serviço

Exemplo do Request

Não é necessário para este endpoint

Exemplo do Response (200 - OK)

{
    "clientProfileData": {
        "documentType": "cpf",
        "userProfileId": "",
        "customerClass": null,
        "email": "[e-mail]",
        "firstName": "Cliente Teste",
        "lastName": "",
        "id": "clientProfileData",
        "document": "08354568032",
        "corporateDocument": null,
        "stateInscription": null,
        "phone": "993131234",
        "corporatePhone": null,
        "corporateName": null,
        "tradeName": null,
        "isCorporate": false
    },
    "marketplaceOrderId": "000004946",
    "packageAttachment": {
        "packages": [
            {
                "items": [
                    {
                        "itemIndex": 0,
                        "quantity": 1,
                        "price": 9990,
                        "description": null
                    }
                ],
                "courier": "VEX LOGISTICA E TRANSPORTES LTDA",
                "invoiceNumber": "000559329",
                "invoiceValue": 9990,
                "invoiceUrl": null,
                "issuanceDate": "2023-08-28T19:26:52",
                "trackingNumber": "253281",
                "invoiceKey": "35230843708379010830550060005593291105593292",
                "trackingUrl": "https://www.fastshop.com.br/web/autoatendimento/acompanhar-pedidos/tracking?guid=f0fe3c76-a9ec-49c5-bc7f-5ef08b2be012",
                "embeddedInvoice": "",
                "type": "Output",
                "courierStatus": {
                    "status": "ok",
                    "finished": true,
                    "deliveredDate": "2023-08-30T21:21:45.717",
                    "data": []
                },
                "cfop": null
            }
        ]
    },
    "items": [
        {
            "sellerSku": "EXDM84X2",
            "shippingPrice": 1000,
            "additionalInfo": {
                "categoriesIds": "//",
                "dimension": null,
                "productClusterId": "",
                "commercialConditionId": "1",
                "brandId": null,
                "brandName": null,
                "offeringInfo": null,
                "offeringType": null,
                "offeringTypeId": null
            },
            "freightCommission": 0,
            "bundleItems": [],
            "params": [],
            "commission": 0,
            "lockId": null,
            "id": "EXDM84X2",
            "quantity": 1,
            "seller": null,
            "price": 100,
            "detailUrl": null,
            "ean": null,
            "name": "Refrigerador Multidoor Electrolux de 03 Portas Frost Free com 579 Litros Painel Eletrônico Inox - DM84X",
            "preSaleDate": null,
            "productId": "EXDM84X_PRD",
            "refId": null,
            "attachments": [],
            "components": [],
            "imageUrl": "",
            "isGift": false,
            "itemAttachment": [],
            "listPrice": 100,
            "manualPrice": null,
            "measurementUnit": "un",
            "offerings": [],
            "priceTags": [],
            "priceValidUntil": null,
            "rewardValue": 0,
            "tax": 0,
            "uniqueId": "",
            "unitMultiplier": 1,
            "sellingPrice": 100
        }
    ],
    "paymentData": {
        "transactions": [
            {
                "transactionId": "be46ba9f-cd1b-407b-bfc5-b051435d2981",
                "merchantName": "FASTSHOP",
                "payments": [
                    {
                        "id": "f6f24e8e-066c-4693-8df7-0e66f1b93c3d",
                        "paymentId": "points",
                        "paymentMethod": "Pontos",
                        "value": 11625,
                        "installments": 6,
                        "interestValue": 0,
                        "cardData": null,
                        "bankBilletData": null,
                        "pixData": null
                    }
                ],
                "isActive": true
            }
        ]
    },
    "shippingData": {
        "logisticsInfo": [
            {
                "addressId": "Entrega",
                "slas": [],
                "deliveryCompany": "Normal",
                "shippingEstimateDate": "2023-09-06T00:00:00",
                "deliveryIds": [
                    {
                        "courierName": "Normal",
                        "quantity": 1,
                        "courierId": "",
                        "warehouseId": "",
                        "dockId": ""
                    }
                ],
                "lockTTL": null,
                "shipsTo": [
                    "BRA"
                ],
                "deliveryChannel": "delivery",
                "pickupStoreInfo": {
                    "isPickupStore": false,
                    "friendlyName": null,
                    "address": null,
                    "additionalInfo": null,
                    "dockId": null
                },
                "price": 0,
                "listPrice": 0,
                "sellingPrice": 0,
                "deliveryWindow": null,
                "shippingEstimate": "",
                "itemIndex": 0,
                "selectedSla": "Normal"
            }
        ],
        "trackingHints": [],
        "selectedAddresses": [
            {
                "addressType": "0",
                "addressId": "Entrega",
                "receiverName": "Cliente Teste",
                "street": "Av. Zaki Narchi",
                "number": "1650",
                "complement": "Casa 1",
                "neighborhood": "Carandiru",
                "postalCode": "02029001",
                "city": "São Paulo",
                "state": "SP",
                "country": "Brasil",
                "reference": null,
                "geoCoordinates": []
            }
        ],
        "address": {
            "addressType": "0",
            "addressId": "Entrega",
            "receiverName": "Cliente Teste",
            "street": "Av. Zaki Narchi",
            "number": "1650",
            "complement": "Casa 1",
            "neighborhood": "Carandiru",
            "postalCode": "02029001",
            "city": "São Paulo",
            "state": "SP",
            "country": "Brasil",
            "reference": null,
            "geoCoordinates": []
        },
        "id": "shippingData"
    },
    "status": "received",
    "statusDescription": "Entregue",
    "marketplaceServicesEndpoint": null,
    "origin": "Marketplace",
    "affiliateId": "",
    "marketplaceItems": [],
    "callCenterOperatorData": null,
    "lastMessage": null,
    "changesAttachment": null,
    "orderFormId": "",
    "sequence": "",
    "merchantName": "FASTSHOP",
    "allowCancellation": false,
    "creationDate": "2023-08-28T19:24:39.153",
    "hostName": "FASTSHOP",
    "followUpEmail": "[e-mail]",
    "isCompleted": true,
    "lastChange": "2023-08-30T21:21:45.717",
    "openTextField": {
        "value": "{\"Parcels\":6,\"TotalValueWithInterest\":635,\"ParcelValue\":1937,\"OrderFastShop\":\"HD0000203\"}"
    },
    "orderId": "HD0000203",
    "sellerOrderId": "HD0000203",
    "sellers": [
        {
            "id": "FASTSHOP_APIGEE",
            "logo": null,
            "name": "FASTSHOP_APIGEE"
        }
    ],
    "totals": [],
    "value": 11625,
    "orderGroup": "000004946",
    "allowEdition": false,
    "commercialConditionData": null,
    "customData": null,
    "giftRegistryData": null,
    "isCheckedIn": false,
    "marketingData": null,
    "ratesAndBenefitsData": null,
    "roundingError": 0,
    "salesChannel": "1",
    "storePreferencesData": {
        "countryCode": "BRA",
        "currencyCode": "BRL",
        "currencyFormatInfo": {
            "currencyDecimalDigits": 2,
            "currencyDecimalSeparator": ",",
            "currencyGroupSeparator": ".",
            "currencyGroupSize": 3,
            "startsWithCurrencySymbol": true
        },
        "currencyLocale": 1046,
        "currencySymbol": "R$",
        "timeZone": "E. South America Standard Time",
        "checkToSavePersonDataByDefault": false,
        "templateOptions": {
            "toggleCorporate": false
        }
    }
}

Descrições dos campos consulte o "Swagger API"

A API permite até 5 requisições por segundo, caso ultrapasse esse limite será retornado status 429: Too Many Request

Mapa dos status do pedido:

Status	Retornado pela endpoint
Pendente	waiting-ffmt-authorization
Processando	processing
Pago	ready-for-handling
Cancelado	canceled
Em Trânsito	invoiced
Faturado	invoiced
Despachado	invoiced
Entregue	received