VTEX · Example Payload

Vtex Placefulfillmentorder Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Placefulfillmentorder Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "PlaceFulfillmentOrder",
  "method": "POST",
  "path": "/api/fulfillment/pvt/orders",
  "summary": "VTex Place fulfillment order",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "response",
      "example": [
        {
          "marketplaceOrderId": "956",
          "orderId": "MBR-956",
          "followUpEmail": "9762a2a9028a4b5d8eb9a8ff909d15ce@ct.vtex.com.br",
          "items": [
            {
              "id": "2",
              "quantity": 1,
              "seller": "1",
              "priceTable": null,
              "comission": 0,
              "freightComission": 0,
              "price": 13890,
              "bundleItems": [],
              "priceTags": [],
              "measurementUnit": "un",
              "unitMultiplier": 1,
              "isGift": false
            }
          ],
          "clientProfileData": {
            "email": "fba45537f5c84d4092cf064da742fe3d@ct.vtex.com.br",
            "firstName": "J\u00falio",
            "lastName": "Augusto de Oliveira",
            "documentType": "cpf",
            "document": "11417984642",
            "phone": "395555258",
            "corporateName": null,
            "tradeName": null,
            "corporateDocument": null,
            "stateInscription": null,
            "corporatePhone": null,
            "isCorporate": false,
            "userProfileId": null
          },
          "shippingData": {
            "isFOB": false,
            "address": {
              "addressType": "Residencial",
              "receiverName": "J\u00falio Augusto de Oliveira",
              "addressId": "Casa",
              "postalCode": "98776003",
              "city": "Americana",
              "state": "SP",
              "country": "BRA",
              "street": "Rua da casa",
              "number": "31187",
              "neighborhood": "Grande circo",
              "complement": null,
              "reference": "Bairro do foca / Posto de Sa\u00fade 65",
              "geoCoordinates": []
            },
            "selectedaddresses": [
              {
                "addressType": "Residencial",
                "receiverName": "J\u00falio Augusto de Oliveira",
                "addressId": "Casa",
                "postalCode": "98776003",
                "city": "Americana",
                "state": "SP",
                "country": "BRA",
                "street": "Rua da casa",
                "number": "31187",
                "neighborhood": "Grande circo",
                "complement": null,
                "reference": "Bairro do foca / Posto de Sa\u00fade 65",
                "geoCoordinates": []
              }
            ],
            "logisticsInfo": [
              {
                "itemIndex": 0,
                "selectedSla": "Correios",
                "addressId": "Casa",
                "selectedDeliveryChannel": "delivery",
                "deliveryIds": [
                  {
                    "warehouseId": "1_1",
                    "dockId": "1"
                  }
                ],
                "lockTTL": "8d",
                "shippingEstimate": "7d",
                "price": 1090,
                "deliveryWindow": null
              }
            ],
            "trackingHints": []
          },
          "paymentData": null,
          "customData": null
        }
      ]
    }
  ]
}