VTEX · Example Payload

Vtex Get Apilogistics Capacityresourcescarriercapacitytypeshippin Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Apilogistics Capacityresourcescarriercapacitytypeshippin 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": "get-apilogistics-capacityresourcescarriercapacitytypeshippingpol",
  "method": "GET",
  "path": "/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames",
  "summary": "VTex Search capacity reservations in time range",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "2021-05-03F1300T1700",
        "resourceId": "carrier@skus_quantity@143e313",
        "startDate": "2021-05-03T13:00:00+00:00",
        "endDate": "2021-05-03T17:00:59+00:00",
        "ownMaxCapacity": 10,
        "resourceMaxCapacity": 10,
        "reservedValue": 6,
        "reservations": [
          {
            "id": "reservation-01",
            "value": 4
          },
          {
            "id": "reserva-02",
            "value": 2
          }
        ],
        "log": [
          {
            "when": "2021-04-29T15:56:09.1732357+00:00",
            "who": "",
            "why": "Reservation `reservation-01` with 2.0 units.",
            "what": "Unblocked"
          },
          {
            "when": "2021-04-29T17:29:11.9250354+00:00",
            "who": "",
            "why": "Reservation `reserva-02` with 4.0 units.",
            "what": "Unblocked"
          }
        ]
      }
    }
  ]
}