VTEX · Example Payload

Vtex Fulfillment Simulation Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Fulfillment Simulation 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": "fulfillment-simulation",
  "method": "POST",
  "path": "/pvt/orderForms/simulation",
  "summary": "VTex Fulfillment simulation - External Seller",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "country": "BRA",
        "items": [
          {
            "id": "2000037",
            "listPrice": 67203,
            "measurementUnit": "un",
            "merchantName": "mySeller1",
            "offerings": [
              {
                "type": "Warranty",
                "id": "5",
                "name": "1 year warranty",
                "price": 10000
              }
            ],
            "price": 67203,
            "priceTags": [],
            "priceValidUntil": "2014-03-01T22:58:28.143",
            "quantity": 1,
            "requestIndex": 0,
            "seller": "1",
            "unitMultiplier": 1
          }
        ],
        "logisticsInfo": [
          {
            "itemIndex": 0,
            "quantity": 1,
            "shipsTo": [
              "BRA"
            ],
            "slas": [
              {
                "id": "Curbside pickup",
                "deliveryChannel": "pickup-in-point",
                "name": "Curbside pickup",
                "shippingEstimate": "0bd",
                "price": 0,
                "availableDeliveryWindows": [
                  {
                    "startDateUtc": "2013-02-04T08:00:00+00:00",
                    "endDateUtc": "2013-02-04T13:00:00+00:00",
                    "price": 0
                  }
                ],
                "pickupStoreInfo": {
                  "isPickupStore": true,
                  "friendlyName": "Santa Felicidade",
                  "address": {
                    "addressType": "pickup",
                    "receiverName": "Juliana",
                    "addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
                    "postalCode": "82320-040",
                    "city": "Curitiba",
                    "state": "PR",
                    "country": "BRA",
                    "street": "Rua Domingos Strapasson",
                    "number": "100",
                    "neighborhood": "Santa Felicidade",
                    "complement": "Loja 10",
                    "reference": "Next to the unicorn statue",
                    "geoCoordinates": [
                      49.334934,
                      25.401705
                    ]
                  },
                  "additionalInfo": ""
                }
              }
            ],
            "stockBalance": 199,
            "deliveryChannels": [
              {
                "id": "delivery",
                "stockBalance": 179
              },
              {
                "id": "pickup-in-point",
                "stockBalance": 20
              }
            ]
          }
        ],
        "postalCode": "80250000",
        "allowMultipleDeliveries": true
      }
    }
  ]
}