Sign in

v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01594762.7 KB
SLA

Calculate SLA

Checkout uses this endpoint to calculate a Service Level Agreement (SLA), a contract between the store and a customer about their order fulfillment conditions, such as the shipping estimated date.

The calculation of the estimated date considers the shipping policy and loading dock related to the order.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
LogisticsLogistics accessLogistics full access
LogisticsLogistics accessLogistics viewer

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Logistics - Full accessLogistics full access
OMS - Full accessLogistics full access
Logistics - Full accessLogistics viewer
Logistics - Read onlyLogistics viewer

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.

post/api/logistics/pvt/shipping/calculate

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

salesChannelstring

Sales channel (trade policy) valid for the SLA calculation.

deliveryChannelstring nullable

Defines if the shipping type is delivery or pickup.

Example request

[
  {
    "items": [
      {
        "id": "1",
        "quantity": 1,
        "price": 14128.9,
        "modal": "FURNITURE",
        "additionalHandlingTime": "00:00:00",
        "dimension": {
          "weight": 86.37,
          "height": 23.5,
          "width": 65,
          "length": 67.5,
          "maxSumDimension": 243.9
        },
        "kitItem": [
          {
            "id": "2",
            "kitItem": [
              "1"
            ],
            "quantity": 1,
            "price": 1,
            "additionalHandlingTime": "00:00:00",
            "dimension": {
              "weight": 1,
              "height": 1,
              "width": 1,
              "length": 1,
              "maxSumDimension": 5
            }
          }
        ],
        "dockId": "1a8bce3",
        "wareHouseId": "1937054"
      }
    ],
    "location": {
      "zipCode": "22780084",
      "country": "BRA",
      "point": [
        -43.23171615600586,
        -22.990713500405295
      ],
      "inStore": {
        "StoreId": "180082"
      }
    },
    "salesChannel": "1",
    "deliveryChannel": "delivery"
  }
]

Response

OK