VTEX · Schema

Sla

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
name	string	Name of the shipping policy.
shippingEstimate	string	Total shipping estimate time in days. For instance, three business days is represented `3bd`.
deliveryWindow	string	[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item.
price	integer	Shipping price for the item in cents. Does not account for the whole order's shipping price.
deliveryChannel	string	If the delivery channel is `delivery` or `pickup-in-point`.
pickupStoreInfo	object
polygonName	string	Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.
lockTTL	string	Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA.
pickupPointId	string	[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.
transitTime	string	Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.
pickupDistance	number	Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Sla",
  "title": "Sla",
  "required": [
    "id",
    "name",
    "shippingEstimate",
    "deliveryWindow",
    "price",
    "deliveryChannel",
    "pickupStoreInfo",
    "polygonName",
    "lockTTL",
    "pickupPointId",
    "transitTime",
    "pickupDistance"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)."
    },
    "name": {
      "type": "string",
      "description": "Name of the shipping policy."
    },
    "shippingEstimate": {
      "type": "string",
      "description": "Total shipping estimate time in days. For instance, three business days is represented `3bd`."
    },
    "deliveryWindow": {
      "type": "string",
      "nullable": true,
      "description": "[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item."
    },
    "price": {
      "type": "integer",
      "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price."
    },
    "deliveryChannel": {
      "type": "string",
      "description": "If the delivery channel is `delivery` or `pickup-in-point`."
    },
    "pickupStoreInfo": {
      "$ref": "#/components/schemas/PickupStoreInfo"
    },
    "polygonName": {
      "type": "string",
      "nullable": true,
      "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy."
    },
    "lockTTL": {
      "type": "string",
      "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA."
    },
    "pickupPointId": {
      "type": "string",
      "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA."
    },
    "transitTime": {
      "type": "string",
      "description": "Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`."
    },
    "pickupDistance": {
      "type": "number",
      "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line."
    }
  },
  "example": {
    "id": "Normal",
    "name": "Normal",
    "shippingEstimate": "5bd",
    "deliveryWindow": null,
    "price": 1160,
    "deliveryChannel": "delivery",
    "pickupStoreInfo": {
      "additionalInfo": null,
      "address": null,
      "dockId": null,
      "friendlyName": null,
      "isPickupStore": false
    },
    "polygonName": null,
    "lockTTL": "12d",
    "pickupPointId": "1_VTEX-RJ",
    "transitTime": "3d",
    "pickupDistance": 0
  }
}