Logistics API
>Check the Fulfillment onboarding guide(https://developers
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://vtex.local"
},
{
"description": "VTEX server URL.",
"url": "https://{accountName}.{environment}.com.br",
"variables": {
"accountName": {
"default": "{accountName}",
"description": "Name of the VTEX account. Used as part of the URL."
},
"environment": {
"default": "{environment}",
"description": "Environment to use. Used as part of the URL."
}
}
}
],
"info": {
"contact": {},
"description": "\r\n\r\n>Check the [Fulfillment onboarding guide](https://developers.vtex.com/docs/guides/fulfillment). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about fulfillment and is organized by focusing on the developer's journey.\r\n\r\nLogistics or fulfillment is the module responsible for shipping calculation and inventory management. \r\n\r\nThe variable `{{environment}}` can be filled with `vtexcommercestable` or `vtexcommercebeta`, depending on the environment you want to test.",
"title": "Logistics API",
"version": "1.0",
"x-origin": [
{
"format": "openapi",
"url": "https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Logistics API.json",
"version": "3.0"
}
],
"x-providerName": "vtex.local",
"x-serviceName": "Logistics-API",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_apis.guru_assets_images_no-logo.svg"
}
},
"security": [
{
"appKey": [],
"appToken": []
}
],
"tags": [
{
"name": "Scheduled Delivery"
},
{
"name": "Shipping Policies"
},
{
"name": "Docks"
},
{
"name": "Warehouses"
},
{
"name": "Inventory"
},
{
"name": "Holidays"
},
{
"name": "Reservations"
},
{
"name": "SLA"
},
{
"name": "Pickup Points"
},
{
"name": "Polygons"
},
{
"name": "Freight Values"
}
],
"paths": {
"/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames": {
"get": {
"deprecated": false,
"description": "Get information on all capacity reservations made to scheduled delivery windows in a given time range.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a \"resource\" in the API's messages.",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/vnd.vtex.availability.v1+json",
"type": "string"
},
"style": "simple"
},
{
"description": "How the delivery capacity is measured as defined in the shipping policy. Capacity can be measured by maximum number of orders (`\"orders_quantity\"`) or SKUs (`\"skus_quantity\"`).",
"in": "path",
"name": "capacityType",
"required": true,
"schema": {
"example": "{{capacityType}}",
"type": "string"
},
"style": "simple"
},
{
"description": "ID of shipping policy to search.",
"in": "path",
"name": "shippingPolicyId",
"required": true,
"schema": {
"example": "{{shippingPolicyId}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Starting date of time range",
"in": "query",
"name": "rangeStart",
"required": true,
"schema": {
"example": "yyyy-mm-dd",
"type": "string"
},
"style": "form"
},
{
"description": "End date of time range.",
"in": "query",
"name": "rangeEnd",
"required": true,
"schema": {
"example": "yyyy-mm-dd",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"endDate": "2021-05-03T17:00:59+00:00",
"id": "2021-05-03F1300T1700",
"log": [
{
"what": "Unblocked",
"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."
}
],
"ownMaxCapacity": 10,
"reservations": [
{
"id": "reservation-01",
"value": 4
},
{
"id": "reserva-02",
"value": 2
}
],
"reservedValue": 6,
"resourceId": "carrier@skus_quantity@143e313",
"resourceMaxCapacity": 10,
"startDate": "2021-05-03T13:00:00+00:00"
}
}
},
"description": "OK"
}
},
"summary": "Search capacity reservations in time range",
"tags": [
"Scheduled Delivery"
]
}
},
"/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}": {
"get": {
"deprecated": false,
"description": "Retrieves capacity usage of a specific scheduled delivery reservation window.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a \"resource\" in the API's messages.",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/vnd.vtex.availability.v1+json",
"type": "string"
},
"style": "simple"
},
{
"description": "How the delivery capacity is measured as defined in the shipping policy. Capacity can be measured by maximum number of orders (`\"orders_quantity\"`) or SKUs (`\"skus_quantity\"`).",
"in": "path",
"name": "capacityType",
"required": true,
"schema": {
"example": "{{capacityType}}",
"type": "string"
},
"style": "simple"
},
{
"description": "ID of shipping policy to search.",
"in": "path",
"name": "shippingPolicyId",
"required": true,
"schema": {
"example": "{{shippingPolicyId}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Day of the specific scheduled delivery window to be consulted for reservations.",
"in": "path",
"name": "windowDay",
"required": true,
"schema": {
"example": "yyyy-mm-dd",
"type": "string"
},
"style": "simple"
},
{
"description": "Start time of specific scheduled delivery window to be consulted for reservations.",
"in": "path",
"name": "windowStartTime",
"required": true,
"schema": {
"example": "hhmm",
"type": "string"
},
"style": "simple"
},
{
"description": "End time of specific scheduled delivery window to be consulted for reservations.",
"in": "path",
"name": "windowEndTime",
"required": true,
"schema": {
"example": "hhmm",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"endDate": "2021-05-03T17:00:59+00:00",
"id": "2021-05-03F1300T1700",
"log": [
{
"what": "Unblocked",
"when": "2021-04-29T15:56:09.1732357+00:00",
"who": "",
"why": "Reservation `reservation-01` with 4 units."
}
],
"ownMaxCapacity": 10,
"reservations": [
{
"id": "reservation-01",
"value": 4
}
],
"reservedValue": 4,
"resourceId": "carrier@skus_quantity@143e313",
"resourceMaxCapacity": 10,
"startDate": "2021-05-03T13:00:00+00:00"
}
}
},
"description": "OK"
}
},
"summary": "Get capacity reservation usage by window",
"tags": [
"Scheduled Delivery"
]
}
},
"/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked": {
"post": {
"deprecated": false,
"description": "Adds blocked delivery windows for your store's shipping policies.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.",
"operationId": "AddBlockedDeliveryWindows",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "carrierId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": "\"2016-08-09T08:00:00\"",
"schema": {
"example": "\"2016-08-09T08:00:00\"",
"type": "string"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Add blocked delivery windows",
"tags": [
"Scheduled Delivery"
]
}
},
"/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked": {
"get": {
"deprecated": false,
"description": "Lists all blocked delivery windows of your store's shipping policies, searching by carrier ID.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.",
"operationId": "RetrieveBlockedDeliveryWindows",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "carrierId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Retrieve blocked delivery windows",
"tags": [
"Scheduled Delivery"
]
}
},
"/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked": {
"post": {
"deprecated": false,
"description": "Removes the blocked delivery windows set to your store's shipping policies.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.",
"operationId": "RemoveBlockedDeliveryWindows",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "carrierId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": "\"2016-08-09T08:00:00\"",
"schema": {
"example": "\"2016-08-09T08:00:00\"",
"type": "string"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Remove blocked delivery windows",
"tags": [
"Scheduled Delivery"
]
}
},
"/api/logistics/pvt/configuration/docks": {
"get": {
"deprecated": false,
"description": "Informs a list of all docks.",
"operationId": "AllDocks",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": [
{
"dockTimeFake": "1.00:00:00",
"freightTableIds": [
"11cc4b6",
"teste1",
"186a2a6",
"1962962",
"173a63f"
],
"id": "1a8bce3",
"name": "Centro de Distribuição Principal",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1",
"2"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
{
"dockTimeFake": "00:00:00",
"freightTableIds": [
"1962962",
"teste1",
"11cc4b6"
],
"id": "1_1_1",
"name": "Doca A",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 1,
"salesChannel": null,
"salesChannels": [
"1",
"11",
"4",
"2",
"12",
"13",
"14",
"7",
"16"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
{
"dockTimeFake": "1.00:00:00",
"freightTableIds": [],
"id": "139270d",
"name": "Doca B",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "1.00:00:00",
"wmsEndPoint": ""
},
{
"dockTimeFake": "00:00:00",
"freightTableIds": [],
"id": "18dd839",
"name": "Doca C",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": "http://recurrent-env-beta.elasticbeanstalk.com/recorrenciawms"
},
{
"dockTimeFake": "1.00:00:00",
"freightTableIds": [],
"id": "avl",
"name": "Doca InStore",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"18"
],
"timeFakeOverhead": "1.00:00:00",
"wmsEndPoint": ""
},
{
"dockTimeFake": "1.00:00:00",
"freightTableIds": [],
"id": "pickup_1",
"name": "Pickup Point 1",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
{
"dockTimeFake": "1.00:00:00",
"freightTableIds": [],
"id": "pickup_2",
"name": "Pickup Point 2",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
{
"dockTimeFake": "1.00:00:00",
"freightTableIds": [],
"id": "pickup_3",
"name": "Pickup Point 3",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
}
],
"schema": {
"items": {
"example": {
"dockTimeFake": "1.00:00:00",
"freightTableIds": [
"11cc4b6",
"teste1",
"186a2a6",
"1962962",
"173a63f"
],
"id": "1a8bce3",
"name": "Centro de Distribuição Principal",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1",
"2"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
"properties": {
"dockTimeFake": {
"type": "string"
},
"freightTableIds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pickupStoreInfo": {
"example": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"properties": {
"additionalInfo": {
"nullable": true,
"type": "string"
},
"address": {
"nullable": true,
"type": "string"
},
"dockId": {
"nullable": true,
"type": "string"
},
"friendlyName": {
"nullable": true,
"type": "string"
},
"isPickupStore": {
"type": "boolean"
},
"storeId": {
"nullable": true,
"type": "string"
}
},
"required": [
"isPickupStore",
"storeId",
"friendlyName",
"address",
"additionalInfo",
"dockId"
],
"title": "PickupStoreInfo1",
"type": "object"
},
"priority": {
"format": "int32",
"type": "integer"
},
"salesChannel": {
"nullable": true,
"type": "string"
},
"salesChannels": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"timeFakeOverhead": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"id",
"name",
"priority",
"dockTimeFake",
"timeFakeOverhead",
"salesChannels",
"salesChannel",
"freightTableIds",
"wmsEndPoint",
"pickupStoreInfo"
],
"type": "object"
},
"type": "array"
}
}
},
"description": "OK",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"example": "gzip",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "469",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 19:58:37 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"Vary": {
"content": {
"text/plain": {
"example": "Accept-Encoding",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx5",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Router": {
"content": {
"text/plain": {
"example": "2.1.155",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Cache-Status-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "MISS",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "4dc9fc80-722a-468f-8f7d-aabe2b804b18",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List all docks",
"tags": [
"Docks"
]
},
"post": {
"deprecated": false,
"description": "Creates or updates docks to be used in your logistic operation.",
"operationId": "Create/UpdateDock",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": [
[
-43.18228090000002,
-22.9460398
]
],
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"dockTimeFake": "00:00:00",
"freightTableIds": [],
"id": "catete",
"name": "Loja Catete",
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
"schema": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": [
[
-43.18228090000002,
-22.9460398
]
],
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"dockTimeFake": "00:00:00",
"freightTableIds": [],
"id": "catete",
"name": "Loja Catete",
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": [
[
-43.18228090000002,
-22.9460398
]
],
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"coordinates"
],
"title": "Address1",
"type": "object"
},
"dockTimeFake": {
"type": "string"
},
"freightTableIds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"salesChannel": {
"nullable": true,
"type": "string"
},
"salesChannels": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"timeFakeOverhead": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"id",
"name",
"priority",
"dockTimeFake",
"timeFakeOverhead",
"salesChannels",
"salesChannel",
"freightTableIds",
"wmsEndPoint",
"address"
],
"title": "Create/UpdateDockRequest",
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Create/update dock",
"tags": [
"Docks"
]
}
},
"/api/logistics/pvt/configuration/docks/{dockId}": {
"delete": {
"deprecated": false,
"description": "Deletes dock by dock ID.",
"operationId": "Dock",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "dockId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Delete dock",
"tags": [
"Docks"
]
},
"get": {
"deprecated": false,
"description": "Informs a given dock's information, searching by dock ID.",
"operationId": "DockById",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "dockId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"dockTimeFake": "1.00:00:00",
"freightTableIds": [
"11cc4b6",
"teste1",
"186a2a6",
"1962962",
"173a63f"
],
"id": "1a8bce3",
"name": "Centro de Distribuição Principal",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1",
"2"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
"schema": {
"example": {
"dockTimeFake": "1.00:00:00",
"freightTableIds": [
"11cc4b6",
"teste1",
"186a2a6",
"1962962",
"173a63f"
],
"id": "1a8bce3",
"name": "Centro de Distribuição Principal",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1",
"2"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
"properties": {
"dockTimeFake": {
"type": "string"
},
"freightTableIds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pickupStoreInfo": {
"example": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"properties": {
"additionalInfo": {
"nullable": true,
"type": "string"
},
"address": {
"nullable": true,
"type": "string"
},
"dockId": {
"nullable": true,
"type": "string"
},
"friendlyName": {
"nullable": true,
"type": "string"
},
"isPickupStore": {
"type": "boolean"
},
"storeId": {
"nullable": true,
"type": "string"
}
},
"required": [
"isPickupStore",
"storeId",
"friendlyName",
"address",
"additionalInfo",
"dockId"
],
"title": "PickupStoreInfo1",
"type": "object"
},
"priority": {
"format": "int32",
"type": "integer"
},
"salesChannel": {
"nullable": true,
"type": "string"
},
"salesChannels": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"timeFakeOverhead": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"id",
"name",
"priority",
"dockTimeFake",
"timeFakeOverhead",
"salesChannels",
"salesChannel",
"freightTableIds",
"wmsEndPoint",
"pickupStoreInfo"
],
"title": "",
"type": "object"
}
}
},
"description": "OK",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "391",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 19:58:51 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx2",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Router": {
"content": {
"text/plain": {
"example": "2.1.155",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Cache-Status-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "MISS",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "7df9de37-d013-4823-bbd7-5726aa8d7f7a",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List dock by ID",
"tags": [
"Docks"
]
}
},
"/api/logistics/pvt/configuration/docks/{dockId}/activation": {
"post": {
"deprecated": false,
"description": "Activates dock through dock ID.",
"operationId": "ActivateDock",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "dockId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Activate dock",
"tags": [
"Docks"
]
}
},
"/api/logistics/pvt/configuration/docks/{dockId}/deactivation": {
"post": {
"deprecated": false,
"description": "Deactivate dock by dock ID",
"operationId": "DeactivateDock",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "dockId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Deactivate dock",
"tags": [
"Docks"
]
}
},
"/api/logistics/pvt/configuration/freights/{carrierId}/values/update": {
"post": {
"deprecated": false,
"description": "Creates or updates the freight values of your store's carriers. Learn more in [Shipping rate template](https://help.vtex.com/en/tutorial/planilha-de-frete--tutorials_127#).",
"operationId": "Create/UpdateFreightValues",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "carrierId",
"required": true,
"schema": {
"example": "carrier123",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"schema": {
"description": "Array of objects, each containing information on a specific freight interval.",
"items": {
"properties": {
"absoluteMoneyCost": {
"description": "Fixed shipping cost to be charged in a decimal number.",
"example": "1.00",
"type": "string"
},
"country": {
"description": "Three letter ISO code for the country where the delivery will take place.",
"example": "BRA",
"type": "string"
},
"maxVolume": {
"description": "Maximum volume that can be transported by the carrier in cm³.",
"example": 1000000000,
"format": "int32",
"type": "integer"
},
"operationType": {
"description": "Indicates desired action for the object. Possible values are `1` (Insert), `2` (Update) or `3`(Delete).",
"example": 1,
"format": "int32",
"type": "integer"
},
"polygon": {
"description": "Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature.",
"example": "polygon2",
"type": "string"
},
"pricePercent": {
"description": "[Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with 10.",
"example": 10,
"format": "int32",
"type": "integer"
},
"pricePercentByWeight": {
"description": "[Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order.",
"example": 0,
"format": "int32",
"type": "integer"
},
"timeCost": {
"description": "Delivery time frame informed by the carrier, in the format DD.HH:MM:SS.",
"example": "2.00:00:00",
"type": "string"
},
"weightEnd": {
"description": "Maximum weight allowed.",
"example": 1000,
"format": "int32",
"type": "integer"
},
"weightStart": {
"description": "Minimum weight allowed",
"example": 1,
"format": "int32",
"type": "integer"
},
"zipCodeEnd": {
"description": "End of postal code interval.",
"example": "1234500",
"type": "string"
},
"zipCodeStart": {
"description": "Start of postal code interval.",
"example": "1000000",
"type": "string"
}
},
"required": [
"absoluteMoneyCost",
"country",
"maxVolume",
"operationType",
"pricePercent",
"pricePercentByWeight",
"timeCost",
"weightEnd",
"weightStart",
"zipCodeEnd",
"zipCodeStart",
"polygon"
],
"title": "Create/UpdateFreightValuesRequest",
"type": "object"
},
"type": "array"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Create/update freight values",
"tags": [
"Freight Values"
]
}
},
"/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values": {
"get": {
"deprecated": false,
"description": "Lists freight values apointed to your store's carriers, searching by carrier ID and postal code (`cep`).",
"operationId": "FreightValues",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Carrier ID",
"in": "path",
"name": "carrierId",
"required": true,
"schema": {
"example": "carrier-123",
"type": "string"
},
"style": "simple"
},
{
"description": "Postal code.",
"in": "path",
"name": "cep",
"required": true,
"schema": {
"example": "12345000",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": [
{
"absoluteMoneyCost": 1,
"country": "BRA",
"maxVolume": 1000000000,
"minimumValueInsurance": 0,
"operationType": 0,
"polygon": "",
"pricePercent": 0,
"pricePercentByWeight": 0,
"restrictedFreights": [],
"timeCost": "2.00:00:00",
"weightEnd": 1000,
"weightStart": 1,
"zipCodeEnd": "99999999",
"zipCodeStart": "0"
},
{
"absoluteMoneyCost": 15,
"country": "BRA",
"maxVolume": 1000000000,
"minimumValueInsurance": 0,
"operationType": 0,
"polygon": "",
"pricePercent": 0,
"pricePercentByWeight": 0,
"restrictedFreights": [],
"timeCost": "2.00:00:00",
"weightEnd": 10000,
"weightStart": 1001.001,
"zipCodeEnd": "99999999",
"zipCodeStart": "0"
},
{
"absoluteMoneyCost": 20,
"country": "BRA",
"maxVolume": 1000000000,
"minimumValueInsurance": 0,
"operationType": 0,
"polygon": "",
"pricePercent": 0,
"pricePercentByWeight": 0,
"restrictedFreights": [],
"timeCost": "2.00:00:00",
"weightEnd": 100000,
"weightStart": 10001.001,
"zipCodeEnd": "99999999",
"zipCodeStart": "0"
}
],
"schema": {
"items": {
"example": {
"absoluteMoneyCost": 1,
"country": "BRA",
"maxVolume": 1000000000,
"minimumValueInsurance": 0,
"operationType": 0,
"polygon": "",
"pricePercent": 0,
"pricePercentByWeight": 0,
"restrictedFreights": [],
"timeCost": "2.00:00:00",
"weightEnd": 1000,
"weightStart": 1,
"zipCodeEnd": "99999999",
"zipCodeStart": "0"
},
"properties": {
"absoluteMoneyCost": {
"type": "number"
},
"country": {
"type": "string"
},
"maxVolume": {
"type": "number"
},
"minimumValueInsurance": {
"type": "number"
},
"operationType": {
"format": "int32",
"type": "integer"
},
"polygon": {
"type": "string"
},
"pricePercent": {
"type": "number"
},
"pricePercentByWeight": {
"type": "number"
},
"restrictedFreights": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"timeCost": {
"type": "string"
},
"weightEnd": {
"type": "number"
},
"weightStart": {
"type": "number"
},
"zipCodeEnd": {
"type": "string"
},
"zipCodeStart": {
"type": "string"
}
},
"required": [
"zipCodeStart",
"zipCodeEnd",
"weightStart",
"weightEnd",
"absoluteMoneyCost",
"pricePercent",
"pricePercentByWeight",
"maxVolume",
"timeCost",
"country",
"operationType",
"restrictedFreights",
"polygon",
"minimumValueInsurance"
],
"type": "object"
},
"type": "array"
}
}
},
"description": "OK",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "919",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 19:49:41 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx1",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Router": {
"content": {
"text/plain": {
"example": "2.1.155",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Cache-Status-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "MISS",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "f0945154-c722-40a6-8c24-3873f8cd16c7",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List freight values",
"tags": [
"Freight Values"
]
}
},
"/api/logistics/pvt/configuration/geoshape": {
"get": {
"deprecated": false,
"description": "Lists stored polygons.",
"operationId": "PagedPolygons",
"parameters": [
{
"description": "",
"explode": true,
"in": "query",
"name": "page",
"required": true,
"schema": {
"example": "{{page}}",
"type": "string"
},
"style": "form"
},
{
"description": "",
"explode": true,
"in": "query",
"name": "perPage",
"required": true,
"schema": {
"example": "{{perPage}}",
"type": "string"
},
"style": "form"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "List paged polygons",
"tags": [
"Polygons"
]
},
"put": {
"deprecated": false,
"description": "Creates or updates your store's polygons by geoshape coordinates and polygon name.",
"operationId": "CreateUpdatePolygon",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"schema": {
"properties": {
"geoShape": {
"properties": {
"coordinates": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
}
},
"required": [
"coordinates"
],
"title": "GeoShape",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"geoShape"
],
"title": "Create/UpdatePolygonRequest",
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Create/update polygon",
"tags": [
"Polygons"
]
}
},
"/api/logistics/pvt/configuration/geoshape/{polygonName}": {
"delete": {
"deprecated": false,
"description": "Deletes polygon set up in your store, by polygon name.",
"operationId": "DeletePolygon",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "polygonName",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Delete polygon",
"tags": [
"Polygons"
]
},
"get": {
"deprecated": false,
"description": "Lists your store's polygons by searching through polygon name",
"operationId": "PolygonbyId",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "polygonName",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "List polygon by ID",
"tags": [
"Polygons"
]
}
},
"/api/logistics/pvt/configuration/holidays": {
"get": {
"deprecated": false,
"description": "Lists information of all holidays.",
"operationId": "AllHolidays",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "List all holidays",
"tags": [
"Holidays"
]
}
},
"/api/logistics/pvt/configuration/holidays/{holidayId}": {
"delete": {
"deprecated": false,
"description": "Deletes given holidays set up in your store.",
"operationId": "Holiday",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "holidayId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Delete holiday",
"tags": [
"Holidays"
]
},
"get": {
"deprecated": false,
"description": "Lists holiday's information by holiday ID.",
"operationId": "HolidayById",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "holidayId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "List holiday by ID",
"tags": [
"Holidays"
]
},
"put": {
"deprecated": false,
"description": "Creates or updates holidays through holiday ID.",
"operationId": "Create/UpdateHoliday",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "holidayId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": {
"name": "Natal",
"startDate": "2016-12-25"
},
"schema": {
"example": {
"name": "Natal",
"startDate": "2016-12-25"
},
"properties": {
"name": {
"type": "string"
},
"startDate": {
"type": "string"
}
},
"required": [
"name",
"startDate"
],
"title": "Create/UpdateHolidayRequest",
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Create/update holiday",
"tags": [
"Holidays"
]
}
},
"/api/logistics/pvt/configuration/pickuppoints": {
"get": {
"deprecated": false,
"description": "Lists all of your store's pickup points.",
"operationId": "ListAllPickupPpoints",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"schema": {
"example": [
{
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.92860984802246,
"longitude": -22.92860984802246
},
"neighborhood": "Catete",
"number": "",
"postalCode": "22220070",
"state": "RJ",
"street": "Rua Artur Bernardes"
},
"businessHours": [
{
"closingTime": "21:00:00",
"dayOfWeek": 0,
"openingTime": "11:00:00"
}
],
"description": "Loja Barra da Tijuca",
"formatted_address": "undefined",
"id": "12345",
"instructions": "Loja Barra da Tijuca",
"isActive": true,
"name": "Loja Barra da Tijuca",
"warehouseId": null
}
],
"items": {
"example": {
"_sort": [
1624907190000
],
"accountGroupId": "814a304c-6fe9-4160-b81e-4c7799170993",
"accountOwnerId": "c97ef6c8-491a-439f-927c-f9918644329f",
"accountOwnerName": "coinshop",
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brasil"
},
"location": {
"latitude": -22.83468,
"longitude": -43.36043
},
"neighborhood": "Barros Filho",
"number": "21000",
"postalCode": "21515-001",
"reference": "",
"state": "RJ",
"street": "Avenida Brasil"
},
"businessHours": [
{
"closingTime": "23:59:00",
"dayOfWeek": 1,
"openingTime": "00:00:00"
},
{
"closingTime": "23:59:00",
"dayOfWeek": 2,
"openingTime": "00:00:00"
},
{
"closingTime": "23:59:00",
"dayOfWeek": 3,
"openingTime": "00:00:00"
},
{
"closingTime": "23:59:00",
"dayOfWeek": 4,
"openingTime": "00:00:00"
},
{
"closingTime": "23:59:00",
"dayOfWeek": 5,
"openingTime": "00:00:00"
}
],
"description": "Pup1 description",
"distance": 1624907186176,
"formatted_address": "undefined",
"id": "777",
"instructions": "",
"isActive": true,
"isThirdPartyPickup": false,
"name": "RetireAqui",
"originalId": "Id",
"parentAccountName": "parent account name",
"pickupHolidays": [],
"seller": "coinshop",
"tagsLabel": []
},
"properties": {
"accountGroupId": {
"description": "Account group ID.",
"type": "string"
},
"accountOwnerId": {
"description": "Account owner ID.",
"type": "string"
},
"accountOwnerName": {
"description": "Account owner name.",
"type": "string"
},
"address": {
"properties": {
"city": {
"description": "City.",
"type": "string"
},
"complement": {
"description": "Address complement.",
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"description": "Three letter ISO code.",
"type": "string"
},
"name": {
"description": "Country name.",
"type": "string"
}
},
"type": "object"
},
"location": {
"description": "Geolocation properties.",
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"type": "object"
},
"neighborhood": {
"description": "Neighborhood.",
"type": "string"
},
"number": {
"description": "Pickup point address number.",
"type": "string"
},
"postalCode": {
"description": "Postal code.",
"type": "string"
},
"state": {
"description": "State.",
"type": "string"
},
"street": {
"description": "Street name.",
"type": "string"
}
},
"type": "object"
},
"businessHours": {
"description": "Business hours information for each day of the week.",
"items": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"description": "Closing time in `hh:mm:ss`.",
"type": "string"
},
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"type": "integer"
},
"openingTime": {
"description": "Opening time in `hh:mm:ss`.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"description": {
"description": "Pickup point description.",
"type": "string"
},
"distance": {
"description": "Distance.",
"type": "number"
},
"formatted_address": {
"description": "Formated address.",
"type": "string"
},
"id": {
"description": "Pickup point ID.",
"type": "string"
},
"instructions": {
"description": "Instructions.",
"type": "string"
},
"isActive": {
"description": "Indicates whether pickup point is active.",
"type": "boolean"
},
"isThirdPartyPickup": {
"description": "Indicates whether pickup point is third party.",
"type": "boolean"
},
"name": {
"description": "Pickup point name.",
"type": "string"
},
"originalId": {
"description": "Original ID.",
"type": "string"
},
"parentAccountName": {
"description": "Parent account name.",
"type": "string"
},
"pickupHolidays": {
"description": "Holidays which apply for pickup point.",
"items": {
"description": "Holliday date.",
"type": "string"
},
"type": "array"
},
"seller": {
"description": "Seller corresponding to pickup point.",
"type": "string"
},
"tagsLabel": {
"description": "List of tags.",
"items": {
"description": "Tag",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "OK"
}
},
"summary": "List all pickup points",
"tags": [
"Pickup points"
]
}
},
"/api/logistics/pvt/configuration/pickuppoints/_search": {
"get": {
"deprecated": false,
"description": "Lists paged pickup points in your store.",
"operationId": "Getpaged",
"parameters": [
{
"description": "",
"explode": true,
"in": "query",
"name": "page",
"required": true,
"schema": {
"example": "{{pageNumber}}",
"type": "string"
},
"style": "form"
},
{
"description": "",
"explode": true,
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"example": "{{pageSize}}",
"type": "string"
},
"style": "form"
},
{
"description": "",
"explode": true,
"in": "query",
"name": "keyword",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "List paged Pickup Points",
"tags": [
"Pickup points"
]
}
},
"/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}": {
"delete": {
"deprecated": false,
"description": "Deletes a given pickup point for your store, by pickup point ID.",
"operationId": "Delete",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "pickupPointId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Delete Pickup Point",
"tags": [
"Pickup points"
]
},
"get": {
"deprecated": false,
"description": "Lists your store's pickup points while searching by ID.",
"operationId": "GetById",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "pickupPointId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.92860984802246,
"longitude": -22.92860984802246
},
"neighborhood": "Catete",
"number": "",
"postalCode": "22220070",
"state": "RJ",
"street": "Rua Artur Bernardes"
},
"businessHours": [
{
"closingTime": "21:00:00",
"dayOfWeek": 0,
"openingTime": "11:00:00"
}
],
"description": "Loja Barra da Tijuca",
"formatted_address": "undefined",
"id": "12345",
"instructions": "Loja Barra da Tijuca",
"isActive": true,
"name": "Loja Barra da Tijuca",
"warehouseId": null
},
"schema": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.92860984802246,
"longitude": -22.92860984802246
},
"neighborhood": "Catete",
"number": "",
"postalCode": "22220070",
"state": "RJ",
"street": "Rua Artur Bernardes"
},
"businessHours": [
{
"closingTime": "21:00:00",
"dayOfWeek": 0,
"openingTime": "11:00:00"
}
],
"description": "Loja Barra da Tijuca",
"formatted_address": "undefined",
"id": "12345",
"instructions": "Loja Barra da Tijuca",
"isActive": true,
"name": "Loja Barra da Tijuca",
"warehouseId": null
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.92860984802246,
"longitude": -22.92860984802246
},
"neighborhood": "Catete",
"number": "",
"postalCode": "22220070",
"state": "RJ",
"street": "Rua Artur Bernardes"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"location": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"location"
],
"title": "Address4",
"type": "object"
},
"businessHours": {
"description": "",
"items": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"type": "string"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"openingTime": {
"type": "string"
}
},
"required": [
"dayOfWeek",
"openingTime",
"closingTime"
],
"title": "BusinessHour",
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"formatted_address": {
"type": "string"
},
"id": {
"type": "string"
},
"instructions": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"name": {
"type": "string"
},
"warehouseId": {
"nullable": true,
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"instructions",
"formatted_address",
"address",
"isActive",
"warehouseId",
"businessHours"
],
"title": "GetById",
"type": "object"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "546",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Wed, 25 Oct 2017 20:24:00 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx-21",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.19",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.44.1-beta",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "beta",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Cache-Status-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "MISS",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.3.54-beta.2+1365",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "d9cb24ab-d650-4728-8a79-a981fbbdc9a2",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List Pickup Point By ID",
"tags": [
"Pickup points"
]
},
"put": {
"deprecated": false,
"description": "Creates or updates [pickup points](https://help.vtex.com/en/subcategory/pickup-points--1c5Btie9ou2Gg2iUo0ggqM#) in your store by Pickup Point ID.",
"operationId": "CreateUpdatePickupPoint",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Pickup Point ID. Cannot contain spaces.",
"in": "path",
"name": "pickupPointId",
"required": true,
"schema": {
"example": "123456789",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": "Grey building",
"state": "RJ",
"street": "Avenida Atlântica"
},
"businessHours": [
{
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 2,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 3,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 4,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 5,
"openingTime": "08:00:00"
}
],
"description": "",
"formatted_address": "undefined",
"id": "1a227d3",
"instructions": "Obrigatório apresentar documento de identificação",
"isActive": true,
"name": "Loja Copacabana",
"tagsLabel": [
"zonasul",
"rio de janeiro"
]
},
"schema": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": "Grey building",
"state": "RJ",
"street": "Avenida Atlântica"
},
"businessHours": [
{
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 2,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 3,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 4,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 5,
"openingTime": "08:00:00"
}
],
"description": "",
"formatted_address": "undefined",
"id": "1a227d3",
"instructions": "Obrigatório apresentar documento de identificação",
"isActive": true,
"name": "Loja Copacabana",
"tagsLabel": [
"zonasul",
"rio de janeiro"
]
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": "Grey building",
"state": "RJ",
"street": "Avenida Atlântica"
},
"properties": {
"city": {
"description": "Address city.",
"example": "Rio de Janeiro",
"type": "string"
},
"complement": {
"description": "Address complement.",
"example": "3rd floor",
"type": "string"
},
"country": {
"properties": {
"acronym": {
"description": "Three letter ISO code of the address country.",
"example": "BRA",
"type": "string"
},
"name": {
"description": "Address country name.",
"example": "Brasil",
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"type": "object"
},
"location": {
"properties": {
"latitude": {
"description": "latitude",
"example": -22.974477767944336,
"type": "number"
},
"longitude": {
"description": "longitude",
"example": -43.18672561645508,
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"neighborhood": {
"description": "Address neighborhood.",
"example": "Botafogo",
"type": "string"
},
"number": {
"description": "Address street number.",
"example": "200",
"type": "string"
},
"postalCode": {
"description": "Postal code.",
"type": "string"
},
"reference": {
"description": "Complement that might help locate the shipping address more precisely in case of delivery.",
"example": "Grey building",
"type": "string"
},
"state": {
"description": "Address state.",
"example": "RJ",
"type": "string"
},
"street": {
"description": "Address street name.",
"example": "Praia de botafogo.",
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"reference",
"location"
],
"type": "object"
},
"businessHours": {
"description": "",
"items": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"type": "string"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"openingTime": {
"type": "string"
}
},
"required": [
"dayOfWeek",
"openingTime",
"closingTime"
],
"title": "BusinessHour",
"type": "object"
},
"type": "array"
},
"description": {
"description": "Pickup point description.",
"example": "Pickup your items in our store.",
"type": "string"
},
"formatted_address": {
"description": "Formated address.",
"type": "string"
},
"id": {
"description": "Pickup Point ID. Cannot contain spaces.",
"example": "123456789",
"type": "string"
},
"instructions": {
"description": "Pickup point instructions.",
"example": "Bring your ID in order to pickup your order.",
"type": "string"
},
"isActive": {
"type": "boolean"
},
"isThirdPartyPickup": {
"type": "boolean"
},
"name": {
"description": "Pickup point name.",
"example": "Pickup store.",
"type": "string"
},
"tagsLabel": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"instructions",
"formatted_address",
"address",
"isActive",
"businessHours",
"tagsLabel"
],
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"businessHours": [
{
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 2,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 3,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 4,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 5,
"openingTime": "08:00:00"
}
],
"description": "",
"formatted_address": "undefined",
"id": "rteste",
"instructions": "Obrigatório apresentar documento de identificação",
"isActive": true,
"name": "Loja Copacabana",
"pickupHolidays": [],
"tagsLabel": [
"zonasul",
"rio de janeiro"
]
},
"schema": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"businessHours": [
{
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 2,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 3,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 4,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 5,
"openingTime": "08:00:00"
}
],
"description": "",
"formatted_address": "undefined",
"id": "rteste",
"instructions": "Obrigatório apresentar documento de identificação",
"isActive": true,
"name": "Loja Copacabana",
"pickupHolidays": [],
"tagsLabel": [
"zonasul",
"rio de janeiro"
]
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"location": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"reference": {
"nullable": true,
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"reference",
"location"
],
"title": "Address2",
"type": "object"
},
"businessHours": {
"description": "",
"items": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"type": "string"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"openingTime": {
"type": "string"
}
},
"required": [
"dayOfWeek",
"openingTime",
"closingTime"
],
"title": "BusinessHour",
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"formatted_address": {
"type": "string"
},
"id": {
"type": "string"
},
"instructions": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"name": {
"type": "string"
},
"pickupHolidays": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"tagsLabel": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"instructions",
"formatted_address",
"address",
"isActive",
"businessHours",
"tagsLabel",
"pickupHolidays"
],
"title": "Create/Update",
"type": "object"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "922",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 14 Dec 2018 17:39:52 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "Powered by VTEX",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.44.60",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.4.58+1915",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "c0c59544-e9bb-476c-81c8-ebf4d5f027f2",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Create/Update Pickup Point",
"tags": [
"Pickup points"
]
}
},
"/api/logistics/pvt/configuration/warehouses": {
"get": {
"deprecated": false,
"description": "Lists information about all warehouses set up in your store.",
"operationId": "AllWarehouses",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": [
{
"id": "1937054",
"isActive": true,
"name": "Estoque A",
"pickupPointIds": [
1,
2,
3
],
"priority": 0,
"warehouseDocks": [
{
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
}
]
},
{
"id": "140ac66",
"isActive": true,
"name": "Estoque B",
"pickupPointIds": [
1,
2,
3
],
"priority": 0,
"warehouseDocks": [
{
"cost": 0,
"dockId": "139270d",
"time": "00:00:00"
}
]
}
],
"schema": {
"items": {
"example": {
"id": "1937054",
"isActive": true,
"name": "Estoque A",
"pickupPointIds": [
1,
2,
3
],
"priority": 0,
"warehouseDocks": [
{
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
}
]
},
"properties": {
"id": {
"description": "Code that identifies a warehouse.",
"example": "warehouse123",
"type": "string"
},
"isActive": {
"description": "Shows if the warehouse is active (`true`) or inactive (`false`).",
"example": true,
"type": "boolean"
},
"name": {
"description": "Name of the warehouse.",
"example": "Main Warehouse",
"type": "string"
},
"pickupPointIds": {
"description": "This field returns a list of the [pickup points' IDs](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the given warehouse.",
"example": [
"NameId1"
],
"items": {},
"type": "array"
},
"priority": {
"description": "If the warehouse was configured as a priority. When no priority was set, the value returns`0`.",
"example": 0,
"type": "integer"
},
"warehouseDocks": {
"description": "Information related to the docks available for the warehouses.",
"items": {
"description": "Information related to the docks available for the given warehouse.",
"example": {
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
},
"properties": {
"cost": {
"description": "Extra charges added to the shipping rate when **Additional shipping costs** are configured.",
"example": 1,
"type": "number"
},
"dockId": {
"description": "Code that identifies a dock.",
"example": "dock1",
"type": "string"
},
"time": {
"description": "This field returns the dock's processing time in days and hours. If none is configured, the request returns `00:00:00`.",
"example": "00:00:00",
"type": "string"
}
},
"required": [
"dockId",
"time",
"cost"
],
"title": "WarehouseDock1",
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"warehouseDocks",
"pickupPointIds",
"priority",
"isActive"
],
"type": "object"
},
"type": "array"
}
}
},
"description": "OK",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "877",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 20:00:55 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx5",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Router": {
"content": {
"text/plain": {
"example": "2.1.155",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Cache-Status-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "MISS",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "718fc3ea-7ad8-458c-a20b-e9cc63df3173",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List all warehouses",
"tags": [
"Warehouses"
]
},
"post": {
"deprecated": false,
"description": "Creates or updates your store's warehouses",
"operationId": "Create/UpdateWarehouse",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": {
"id": "15bfc76",
"name": "Estoque Principal",
"warehouseDocks": [
{
"cost": "5.00",
"costToDisplay": "5,00",
"dockId": "1a8bce3",
"name": "Centro de Distribuição Principal",
"time": "3.00:00:00",
"translateDays": "dias"
}
]
},
"schema": {
"example": {
"id": "15bfc76",
"name": "Estoque Principal",
"warehouseDocks": [
{
"cost": "5.00",
"costToDisplay": "5,00",
"dockId": "1a8bce3",
"name": "Centro de Distribuição Principal",
"time": "3.00:00:00",
"translateDays": "dias"
}
]
},
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"warehouseDocks": {
"description": "",
"items": {
"example": {
"cost": "5.00",
"costToDisplay": "5,00",
"dockId": "1a8bce3",
"name": "Centro de Distribuição Principal",
"time": "3.00:00:00",
"translateDays": "dias"
},
"properties": {
"cost": {
"type": "string"
},
"costToDisplay": {
"type": "string"
},
"dockId": {
"type": "string"
},
"name": {
"type": "string"
},
"time": {
"type": "string"
},
"translateDays": {
"type": "string"
}
},
"required": [
"dockId",
"name",
"time",
"cost",
"translateDays",
"costToDisplay"
],
"title": "WarehouseDock",
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"warehouseDocks"
],
"title": "Create/UpdateWarehouseRequest",
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Create/update warehouse",
"tags": [
"Warehouses"
]
}
},
"/api/logistics/pvt/configuration/warehouses/{warehouseId}": {
"delete": {
"deprecated": false,
"description": "Deletes given warehouse by warehouse ID.",
"operationId": "RemoveWarehouse",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Remove warehouse",
"tags": [
"Warehouses"
]
},
"get": {
"deprecated": false,
"description": "Lists the information of a given warehouse, searching by warehouse ID.",
"operationId": "WarehouseById",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"id": "15bfc76",
"isActive": true,
"name": "Estoque Principal",
"pickupPointIds": [
1,
2,
3
],
"priority": 0,
"warehouseDocks": [
{
"cost": 5,
"dockId": "1a8bce3",
"time": "3.00:00:00"
}
]
},
"schema": {
"example": {
"id": "1937054",
"isActive": true,
"name": "Estoque A",
"pickupPointIds": [
1,
2,
3
],
"priority": 0,
"warehouseDocks": [
{
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
}
]
},
"properties": {
"id": {
"type": "string"
},
"isActive": {
"description": "Shows if the warehouse is active (`true`) or inactive (`false`).",
"example": true,
"type": "boolean"
},
"name": {
"type": "string"
},
"pickupPointIds": {
"description": "This field returns a list of the [pickup points' IDs](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the given warehouse.",
"example": [
"NameId1"
],
"items": {},
"type": "array"
},
"priority": {
"description": "If the warehouse was configured as a priority. When no priority was set, the value returns`0`.",
"example": 0,
"type": "integer"
},
"warehouseDocks": {
"description": "",
"items": {
"example": {
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
},
"properties": {
"cost": {
"type": "number"
},
"dockId": {
"type": "string"
},
"time": {
"type": "string"
}
},
"required": [
"dockId",
"time",
"cost"
],
"title": "WarehouseDock1",
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"example": "gzip",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "119",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 20:01:12 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx5",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Cache-Status-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "MISS",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Processado": {
"content": {
"text/plain": {
"example": "119",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-SO": {
"content": {
"text/plain": {
"example": "Linux",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "22863291-d5a7-43a6-b611-352e80d6fd24",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List warehouse by ID",
"tags": [
"Warehouses"
]
}
},
"/api/logistics/pvt/configuration/warehouses/{warehouseId}/activation": {
"post": {
"deprecated": false,
"description": "Activates a given warehouse, by warehouse ID.",
"operationId": "ActivateWarehouse",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Activate warehouse",
"tags": [
"Warehouses"
]
}
},
"/api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation": {
"post": {
"deprecated": false,
"description": "Deactivates a given warehouse by warehouse ID.",
"operationId": "DeactivateWarehouse",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Deactivate warehouse",
"tags": [
"Warehouses"
]
}
},
"/api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched": {
"get": {
"deprecated": false,
"description": "Lists inventory with dispatched reservations. When the number of active reservations is more than 2000 the return is an error with status code 400 (BadRequest) and the message: Too many active reservations.",
"operationId": "Getinventorywithdispatchedreservations",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "itemId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"example": [
{
"availableQuantity": 2147483647,
"dispatchedReservationsQuantity": 0,
"isUnlimitedQuantity": true,
"quantity": 2147483647,
"skuId": "1",
"totalReservedQuantity": 0,
"warehouseId": "1"
}
],
"items": {
"properties": {
"availableQuantity": {
"description": "Available quantity.",
"type": "integer"
},
"dispatchedReservationsQuantity": {
"description": "Dispatched reservations quantity.",
"type": "integer"
},
"isUnlimitedQuantity": {
"description": "Indicates whether the SKU's availability is unlimited (\"infinite inventory\").",
"type": "boolean"
},
"quantity": {
"description": "SKU quantity.",
"type": "integer"
},
"skuId": {
"description": "SKU ID.",
"type": "string"
},
"totalReservedQuantity": {
"description": "Total reserved quantity of the SKU.",
"type": "integer"
},
"warehouseId": {
"description": "Warehouse ID.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "OK"
}
},
"summary": "List inventory with dispatched reservations",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}": {
"get": {
"deprecated": false,
"description": "Lists inventory information per dock set up in your store.",
"operationId": "Inventoryperdock",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "dockId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"example": [
{
"availableQuantity": 1000000,
"dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
"deliveryChannels": [
"delivery"
],
"dockId": "1",
"isUnlimited": true,
"keepSellingAfterExpiration": false,
"reservedQuantity": 0,
"salesChannel": [
"1"
],
"skuId": "1",
"supplyLotId": null,
"timeToRefill": "01:50:00",
"totalQuantity": 1000000,
"transfer": "transfer1",
"warehouseId": "1"
},
{
"availableQuantity": 1000000,
"dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
"deliveryChannels": [
"delivery"
],
"dockId": "1",
"isUnlimited": true,
"keepSellingAfterExpiration": false,
"reservedQuantity": 117,
"salesChannel": [
"1"
],
"skuId": "1",
"supplyLotId": null,
"timeToRefill": "01:50:00",
"totalQuantity": 1000117,
"transfer": "transfer2",
"warehouseId": "1_1"
}
],
"items": {
"properties": {
"availableQuantity": {
"description": "Amount of items available for sale. Difference between total quantity and reserved quantity.",
"type": "integer"
},
"dateOfSupplyUtc": {
"description": "Date of supply lot in UTC.",
"type": "string"
},
"deliveryChannel": {
"description": "List of delivery channels available.",
"items": {
"type": "string"
},
"type": "array"
},
"dockId": {
"description": "Dock ID.",
"type": "string"
},
"isUnlimited": {
"description": "Indicates whether the SKU's availability is unlimited (\"infinite inventory\").",
"type": "boolean"
},
"keepSellingAfterExpiration": {
"description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0.",
"type": "boolean"
},
"reservedQuantity": {
"description": "Reserved quantity of the SKU.",
"type": "integer"
},
"salesChannel": {
"description": "List of sales channels associated.",
"items": {
"type": "string"
},
"type": "array"
},
"skuId": {
"description": "SKU ID.",
"type": "string"
},
"timeToRefill": {
"description": "Time to refill (deprecated).",
"type": "string"
},
"totalQuantity": {
"description": "Total quantity of SKU.",
"type": "integer"
},
"transfer": {
"description": "Transfer.",
"type": "string"
},
"warehouseId": {
"description": "Warehouse ID.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "OK"
}
},
"summary": "List inventory per dock",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}": {
"get": {
"deprecated": false,
"description": "Lists information of inventory per dock and warehouse.",
"operationId": "Inventoryperdockandwarehouse",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "dockId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"example": [
{
"availableQuantity": 1000000,
"dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
"deliveryChannels": [
"delivery"
],
"dockId": "1",
"isUnlimited": true,
"keepSellingAfterExpiration": false,
"reservedQuantity": 0,
"salesChannel": [
"1"
],
"skuId": "1",
"supplyLotId": null,
"timeToRefill": "12:50:00",
"totalQuantity": 1000000,
"transfer": "Tranfer1",
"warehouseId": "1"
}
],
"items": {
"properties": {
"availableQuantity": {
"description": "Amount of items available for sale. Difference between total quantity and reserved quantity.",
"type": "integer"
},
"dateOfSupplyUtc": {
"description": "Date of supply lot in UTC.",
"type": "string"
},
"deliveryChannel": {
"description": "List of delivery channels available.",
"items": {
"type": "string"
},
"type": "array"
},
"dockId": {
"description": "Dock ID.",
"type": "string"
},
"isUnlimited": {
"description": "Indicates whether the SKU's availability is unlimited (\"infinite inventory\").",
"type": "boolean"
},
"keepSellingAfterExpiration": {
"description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0.",
"type": "boolean"
},
"reservedQuantity": {
"description": "Reserved quantity of the SKU.",
"type": "integer"
},
"salesChannel": {
"description": "List of sales channels associated.",
"items": {
"type": "string"
},
"type": "array"
},
"skuId": {
"description": "SKU ID.",
"type": "string"
},
"timeToRefill": {
"description": "Time to refill (deprecated).",
"type": "string"
},
"totalQuantity": {
"description": "Total quantity of SKU.",
"type": "integer"
},
"transfer": {
"description": "Transfer.",
"type": "string"
},
"warehouseId": {
"description": "Warehouse ID.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "OK"
}
},
"summary": "List inventory per dock and warehouse",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}": {
"get": {
"deprecated": false,
"description": "Lists inventory information per warehouse on your store.",
"operationId": "Inventoryperwarehouse",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"example": [
{
"availableQuantity": 1000000,
"dateOfSupplyUtc": "12020-04-05T00:00:00+00:00",
"deliveryChannels": [
"delivery"
],
"dockId": "1",
"isUnlimited": true,
"keepSellingAfterExpiration": false,
"reservedQuantity": 0,
"salesChannel": [
"1"
],
"skuId": "1",
"supplyLotId": "05-05-22",
"timeToRefill": "1",
"totalQuantity": 1000000,
"transfer": "Transfer 1",
"warehouseId": "1"
}
],
"items": {
"properties": {
"availableQuantity": {
"description": "Amount of items available for sale. Difference between total quantity and reserved quantity.",
"type": "integer"
},
"dateOfSupplyUtc": {
"description": "Date of supply lot in UTC.",
"type": "string"
},
"deliveryChannel": {
"description": "List of delivery channels available.",
"items": {
"type": "string"
},
"type": "array"
},
"dockId": {
"description": "Dock ID.",
"type": "string"
},
"isUnlimited": {
"description": "Indicates whether the SKU's availability is unlimited (\"infinite inventory\").",
"type": "boolean"
},
"keepSellingAfterExpiration": {
"description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0.",
"type": "boolean"
},
"reservedQuantity": {
"description": "Reserved quantity of the SKU.",
"type": "integer"
},
"salesChannel": {
"description": "List of sales channels associated.",
"items": {
"type": "string"
},
"type": "array"
},
"skuId": {
"description": "SKU ID.",
"type": "string"
},
"timeToRefill": {
"description": "Time to refill (deprecated).",
"type": "string"
},
"totalQuantity": {
"description": "Total quantity of SKU.",
"type": "integer"
},
"transfer": {
"description": "Transfer.",
"type": "string"
},
"warehouseId": {
"description": "Warehouse ID.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "OK"
}
},
"summary": "List inventory per warehouse",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots": {
"get": {
"deprecated": false,
"description": "Returns a list of the supply lots of an SKU in a specific warehouse.",
"operationId": "GetSupplyLots",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent.",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the SKU.",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the warehouse where the SKU is located.",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "List supply lots",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}": {
"put": {
"deprecated": false,
"description": "Creates a new Supply Lot. A Supply Lot lets the store sell products that are not currently available in stock but whose arrival is already scheduled.\n\nCheck out our [documentation](https://help.vtex.com/en/tutorial/setting-up-future-inventory--UMSGjooqRfkRbeoh94kS4) about this feature.",
"operationId": "SaveSupplyLot",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the SKU whose availability is being scheduled.",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the warehouse where the SKU will arrive.",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the Supply Lot in which the SKU's scheduling should be considered.",
"in": "path",
"name": "supplyLotId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": {
"dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
"keepSellingAfterExpiration": true,
"quantity": 1000
},
"schema": {
"example": {
"dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
"keepSellingAfterExpiration": true,
"quantity": 1000
},
"properties": {
"dateOfSupplyUtc": {
"type": "string"
},
"keepSellingAfterExpiration": {
"type": "boolean"
},
"quantity": {
"type": "number"
}
},
"required": [
"quantity",
"dateOfSupplyUtc",
"keepSellingAfterExpiration"
],
"title": "SaveSupplyLot",
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Save supply lot",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer": {
"post": {
"deprecated": false,
"description": "Transfers an SKU from a Supply Lot to the currently available inventory.\n\nCheck out how this transfer works in further detail by reading our [documentation](https://help.vtex.com/pt/tutorial/configurar-estoque-futuro--UMSGjooqRfkRbeoh94kS4) about this feature.",
"operationId": "TransferSupplyLot",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the SKU.",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the warehouse where the SKU is located.",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the Supply Lot in which the SKU is currently located and from where it will be transfered.",
"in": "path",
"name": "supplyLotId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Transfer supply lot",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/reservations": {
"post": {
"deprecated": false,
"description": "Creates [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).",
"operationId": "CreateReservation",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent.",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": {
"autorizationExpirationTTL": "00:10:00",
"deliveryItemOptions": [
{
"aditionalTimeBlockedDays": "00:00:00",
"deliveryWindows": [],
"dockId": "1a8bce3",
"dockTime": "00:00:00",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"promotionalPrice": 10.5,
"slaType": "Expressa",
"slaTypeName": "Expressa",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": null
}
],
"lockId": null,
"salesChannel": "1"
},
"schema": {
"example": {
"autorizationExpirationTTL": "00:10:00",
"deliveryItemOptions": [
{
"aditionalTimeBlockedDays": "00:00:00",
"deliveryWindows": [],
"dockId": "1a8bce3",
"dockTime": "00:00:00",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"promotionalPrice": 10.5,
"slaType": "Expressa",
"slaTypeName": "Expressa",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": null
}
],
"lockId": null,
"salesChannel": "1"
},
"properties": {
"autorizationExpirationTTL": {
"type": "string"
},
"deliveryItemOptions": {
"description": "",
"items": {
"example": {
"aditionalTimeBlockedDays": "00:00:00",
"deliveryWindows": [],
"dockId": "1a8bce3",
"dockTime": "00:00:00",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"promotionalPrice": 10.5,
"slaType": "Expressa",
"slaTypeName": "Expressa",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": null
},
"properties": {
"aditionalTimeBlockedDays": {
"type": "string"
},
"deliveryWindows": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "Item",
"type": "object"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": null
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"nullable": true,
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore",
"type": "object"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"inStore"
],
"title": "Location",
"type": "object"
},
"promotionalPrice": {
"type": "number"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"slaType",
"slaTypeName",
"listPrice",
"promotionalPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"aditionalTimeBlockedDays",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"location"
],
"title": "DeliveryItemOption",
"type": "object"
},
"type": "array"
},
"lockId": {
"nullable": true,
"type": "string"
},
"salesChannel": {
"type": "string"
}
},
"required": [
"salesChannel",
"lockId",
"autorizationExpirationTTL",
"deliveryItemOptions"
],
"title": "CreateReservationRequest",
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"AuthorizedDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"CanceledDateUtc": "0001-01-01T00:00:00+00:00",
"ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
"Errors": [],
"IsSucess": true,
"LastUpdateDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4",
"MaximumConfirmationDateUtc": "2016-04-15T20:09:20.0397988+00:00",
"PickupPointItemOptions": null,
"ReservationDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"SalesChannel": "2",
"SlaRequest": [
{
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
}
],
"Status": 1
},
"schema": {
"example": {
"AuthorizedDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"CanceledDateUtc": "0001-01-01T00:00:00+00:00",
"ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
"Errors": [],
"IsSucess": true,
"LastUpdateDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4",
"MaximumConfirmationDateUtc": "2016-04-15T20:09:20.0397988+00:00",
"PickupPointItemOptions": null,
"ReservationDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"SalesChannel": "2",
"SlaRequest": [
{
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
}
],
"Status": 1
},
"properties": {
"AuthorizedDateUtc": {
"type": "string"
},
"CanceledDateUtc": {
"type": "string"
},
"ConfirmedDateUtc": {
"type": "string"
},
"Errors": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"IsSucess": {
"type": "boolean"
},
"LastUpdateDateUtc": {
"type": "string"
},
"LockId": {
"type": "string"
},
"MaximumConfirmationDateUtc": {
"type": "string"
},
"PickupPointItemOptions": {
"nullable": true,
"type": "string"
},
"ReservationDateUtc": {
"type": "string"
},
"SalesChannel": {
"type": "string"
},
"SlaRequest": {
"description": "",
"items": {
"example": {
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
},
"properties": {
"deliveryWindows": {
"nullable": true,
"type": "string"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"freightTableId": {
"type": "string"
},
"freightTableName": {
"type": "string"
},
"item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "Dimension1",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"modal": {
"nullable": true,
"type": "string"
},
"price": {
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unlimitedQuantity": {
"type": "boolean"
}
},
"required": [
"id",
"groupItemId",
"quantity",
"price",
"modal",
"additionalHandlingTime",
"dimension",
"kitItem",
"unlimitedQuantity"
],
"title": "Item1",
"type": "object"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"deliveryPointId": {
"nullable": true,
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"point": {
"nullable": true,
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"deliveryPointId",
"point",
"inStore"
],
"title": "Location1",
"type": "object"
},
"pickupStoreInfo": {
"nullable": true,
"type": "string"
},
"promotionalPrice": {
"type": "number"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"item",
"slaType",
"slaTypeName",
"freightTableName",
"freightTableId",
"listPrice",
"promotionalPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"wmsEndPoint",
"location",
"pickupStoreInfo"
],
"title": "SlaRequest",
"type": "object"
},
"type": "array"
},
"Status": {
"format": "int32",
"type": "integer"
}
},
"required": [
"LastUpdateDateUtc",
"SalesChannel",
"LockId",
"ReservationDateUtc",
"MaximumConfirmationDateUtc",
"Status",
"SlaRequest",
"PickupPointItemOptions",
"CanceledDateUtc",
"AuthorizedDateUtc",
"ConfirmedDateUtc",
"Errors",
"IsSucess"
],
"type": "object"
}
}
},
"description": "OK",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"example": "gzip",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "620",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 19:59:18 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"Vary": {
"content": {
"text/plain": {
"example": "Accept-Encoding",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx5",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Router": {
"content": {
"text/plain": {
"example": "2.1.155",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "4e3847c0-596e-4abd-a761-e711bb68bdfa",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Create reservation",
"tags": [
"Reservations"
]
}
},
"/api/logistics/pvt/inventory/reservations/{reservationId}": {
"get": {
"deprecated": false,
"description": "Lists reservation's information by ID.",
"operationId": "ReservationById",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "reservationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"AuthorizedDateUtc": "2016-04-15T19:59:40.9832533+00:00",
"CanceledDateUtc": "0001-01-01T00:00:00+00:00",
"ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
"Errors": [],
"IsSucess": true,
"LastUpdateDateUtc": "2016-04-15T19:59:40.9832533+00:00",
"LockId": "621a9121-06c9-4731-96d1-edf8c5c23877",
"MaximumConfirmationDateUtc": "2016-04-15T20:09:40.9832533+00:00",
"PickupPointItemOptions": "PUP 1",
"ReservationDateUtc": "2016-04-15T19:59:40.9832533+00:00",
"SalesChannel": "2",
"SlaRequest": [
{
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
}
],
"Status": 1
},
"schema": {
"example": {
"AuthorizedDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"CanceledDateUtc": "0001-01-01T00:00:00+00:00",
"ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
"Errors": [],
"IsSucess": true,
"LastUpdateDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4",
"MaximumConfirmationDateUtc": "2016-04-15T20:09:20.0397988+00:00",
"PickupPointItemOptions": "PUP 1",
"ReservationDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"SalesChannel": "2",
"SlaRequest": [
{
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
}
],
"Status": 1
},
"properties": {
"AuthorizedDateUtc": {
"description": "Authorized date in UTC.",
"type": "string"
},
"CanceledDateUtc": {
"description": "Canceled date in UTC.",
"type": "string"
},
"ConfirmedDateUtc": {
"description": "Confirmed date in UTC.",
"type": "string"
},
"Errors": {
"description": "Information on errors, if there are any.",
"items": {
"type": "string"
},
"type": "array"
},
"IsSucess": {
"type": "boolean"
},
"LastUpdateDateUtc": {
"description": "Date of the last update in UTC.",
"type": "string"
},
"LockId": {
"description": "Lock ID.",
"type": "string"
},
"MaximumConfirmationDateUtc": {
"description": "Maximum confirmation date in UTC.",
"type": "string"
},
"PickupPointItemOptions": {
"description": "Pickup point item options.",
"type": "string"
},
"ReservationDateUtc": {
"description": "Reservation date in UTC.",
"type": "string"
},
"SalesChannel": {
"description": "Sales channel.",
"type": "string"
},
"SlaRequest": {
"description": "Information on SLA request.",
"items": {
"properties": {
"deliveryWindows": {
"nullable": true,
"type": "string"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"freightTableId": {
"type": "string"
},
"freightTableName": {
"type": "string"
},
"item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "Dimension1",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"modal": {
"nullable": true,
"type": "string"
},
"price": {
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unlimitedQuantity": {
"type": "boolean"
}
},
"required": [
"id",
"groupItemId",
"quantity",
"price",
"modal",
"additionalHandlingTime",
"dimension",
"kitItem",
"unlimitedQuantity"
],
"title": "Item1",
"type": "object"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"deliveryPointId": {
"nullable": true,
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"point": {
"nullable": true,
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"deliveryPointId",
"point",
"inStore"
],
"title": "Location1",
"type": "object"
},
"pickupStoreInfo": {
"nullable": true,
"type": "string"
},
"promotionalPrice": {
"type": "number"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"Status": {
"description": "Reservation status, being:\n\r`0`: `NotCommitted`\n\r`1`: `Authorized`\n\r`2`: `Confirmed`\n\r`3`: `Canceled_AbortedCommitted`\n\r`4`: `Canceled_AuthorizationExpired`\n\r`5`: `Canceled_Manually`",
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"example": "gzip",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "621",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 20:00:01 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"Vary": {
"content": {
"text/plain": {
"example": "Accept-Encoding",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx5",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Router": {
"content": {
"text/plain": {
"example": "2.1.155",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Cache-Status-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "MISS",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "ffa62df6-4fd0-4cf0-a348-1f3964abc4c4",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List reservation by ID",
"tags": [
"Reservations"
]
}
},
"/api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge": {
"post": {
"deprecated": false,
"description": "Acknowledges reservations made by reservation ID.",
"operationId": "AcknowledgmentReservation",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "reservationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Acknowledgment reservation",
"tags": [
"Reservations"
]
}
},
"/api/logistics/pvt/inventory/reservations/{reservationId}/cancel": {
"post": {
"deprecated": false,
"description": "Cancels reservation by reservation ID.",
"operationId": "CancelReservation",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "reservationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Cancel reservation",
"tags": [
"Reservations"
]
}
},
"/api/logistics/pvt/inventory/reservations/{reservationId}/confirm": {
"post": {
"deprecated": false,
"description": "Confirms reservation by reservation ID.",
"operationId": "ConfirmReservation",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "reservationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Confirm reservation",
"tags": [
"Reservations"
]
}
},
"/api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId}": {
"get": {
"deprecated": false,
"description": "Lists reservations in your store, by searching through warehouse and SKU.",
"operationId": "ReservationbyWarehouseandSku",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "List reservation by warehouse and SKU",
"tags": [
"Reservations"
]
}
},
"/api/logistics/pvt/inventory/skus/{skuId}": {
"get": {
"deprecated": false,
"description": "Lists your store's inventory by SKU ID",
"operationId": "InventoryBySku",
"parameters": [
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"balance": [
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 9,
"totalQuantity": 101,
"warehouseId": "1937054",
"warehouseName": "Estoque A"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "avl",
"warehouseName": "Estoque InStore"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "1448dc2",
"warehouseName": "Estoque C"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "140ac66",
"warehouseName": "Estoque B"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "pickuppoint",
"warehouseName": "PickupPoint"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 200,
"warehouseId": "pickuppoint_2",
"warehouseName": "PickupPoint 2"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 1011,
"warehouseId": "15bfc76",
"warehouseName": "Estoque Principal"
}
],
"skuId": "2390059"
},
"schema": {
"example": {
"balance": [
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 9,
"totalQuantity": 101,
"warehouseId": "1937054",
"warehouseName": "Estoque A"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "avl",
"warehouseName": "Estoque InStore"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "1448dc2",
"warehouseName": "Estoque C"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "140ac66",
"warehouseName": "Estoque B"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "pickuppoint",
"warehouseName": "PickupPoint"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 200,
"warehouseId": "pickuppoint_2",
"warehouseName": "PickupPoint 2"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 1011,
"warehouseId": "15bfc76",
"warehouseName": "Estoque Principal"
}
],
"skuId": "2390059"
},
"properties": {
"balance": {
"description": "",
"items": {
"example": {
"hasUnlimitedQuantity": false,
"reservedQuantity": 9,
"totalQuantity": 101,
"warehouseId": "1937054",
"warehouseName": "Estoque A"
},
"properties": {
"hasUnlimitedQuantity": {
"type": "boolean"
},
"reservedQuantity": {
"format": "int32",
"type": "integer"
},
"totalQuantity": {
"format": "int32",
"type": "integer"
},
"warehouseId": {
"type": "string"
},
"warehouseName": {
"type": "string"
}
},
"required": [
"warehouseId",
"warehouseName",
"totalQuantity",
"reservedQuantity",
"hasUnlimitedQuantity"
],
"title": "Balance",
"type": "object"
},
"type": "array"
},
"skuId": {
"type": "string"
}
},
"required": [
"skuId",
"balance"
],
"type": "object"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "926",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 20 May 2016 14:11:32 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/10.0",
"schema": {
"type": "string"
}
}
}
},
"X-AspNet-Version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-By": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "79a7a62f-03b8-42f8-bcb9-686bb6d67155",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "List inventory by SKU",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}": {
"put": {
"deprecated": false,
"description": "Updates inventory for a given SKU and warehouse.",
"operationId": "UpdateInventoryBySkuandWarehouse",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent.",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "skuId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "warehouseId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": {
"dateUtcOnBalanceSystem": "null",
"quantity": 101,
"timeToRefill (deprecated)": "00:00:00",
"unlimitedQuantity": false
},
"schema": {
"example": {
"dateUtcOnBalanceSystem": "2022-03-15T00:52:16",
"quantity": 101,
"timeToRefill (deprecated)": "00:00:00",
"unlimitedQuantity": false
},
"properties": {
"dateUtcOnBalanceSystem": {
"description": "Defines the corresponding moment to the informed warehouse. It is useful due to the liberation of handling order reservations. \r\n\r\nWhen requested as `null`, this value will be the date/time of the request. Its format is `DateTimeOffset`, as in `yyyy-mm-dd-Thh:mm:ss`. For example: `2022-03-15T00:52:16`.",
"example": "null",
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"timeToRefill (deprecated)": {
"type": "string"
},
"unlimitedQuantity": {
"type": "boolean"
}
},
"required": [
"unlimitedQuantity",
"quantity",
"timeToRefill (deprecated)"
],
"title": "UpdateInventoryBySkuandWarehouseRequest",
"type": "object"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Update inventory by SKU and warehouse",
"tags": [
"Inventory"
]
}
},
"/api/logistics/pvt/shipping-policies": {
"get": {
"description": "This endpoint lists existing shipping policies from carriers in your store.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Desired number of pages to retrieve information from your Shipping Policies.",
"in": "query",
"name": "page",
"required": true,
"schema": {
"example": "page",
"type": "string"
}
},
{
"description": "Desired number of items per page, to retrieve information from your Shipping Policies.",
"in": "query",
"name": "perPage",
"required": true,
"schema": {
"example": "perPage",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "List shipping policies",
"tags": [
"Shipping Policies"
]
},
"post": {
"description": "This endpoint creates new shipping policies from carriers in your store.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"businessHourSettings": {
"description": "Business hour configuration.",
"example": {
"carrierBusinessHours": [
{
"closingTime": "18:59:59",
"dayOfWeek": 0,
"openingTime": "09:00:00"
}
],
"isOpenOutsideBusinessHours": true
},
"properties": {
"carrierBusinessHours": {
"description": "Array containing objects with business hour configurations.",
"items": {
"description": "Object containing business hour configuration.",
"properties": {
"closingTime": {
"description": "Closing time.",
"example": "23:59:59",
"title": "closingTime",
"type": "string"
},
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 1,
"title": "dayOfWeek",
"type": "integer"
},
"openingTime": {
"description": "Opening time.",
"example": "00:00:00",
"title": "openingTime",
"type": "string"
}
},
"required": [
"openingTime",
"closingTime",
"dayOfWeek"
],
"type": "object"
},
"title": "carrierBusinessHours",
"type": "array"
},
"isOpenOutsideBusinessHours": {
"description": "Select whether the shipping policy allows deliveries outside business hours.",
"example": true,
"title": "isOpenOutsideBusinessHours",
"type": "boolean"
}
},
"required": [
"carrierBusinessHours",
"isOpenOutsideBusinessHours"
],
"title": "businessHourSettings",
"type": "object"
},
"carrierSchedule": {
"description": "Schedule sent by the carrier, to configure Shipping policy",
"items": {
"properties": {
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 0,
"type": "integer"
},
"timeLimit": {
"description": "Time limit.",
"example": "time_limit",
"type": "string"
}
},
"type": "object"
},
"title": "carrierSchedule",
"type": "array"
},
"cubicWeightSettings": {
"description": "Measure that accounts package's volume, and not only weight.",
"example": {
"minimunAcceptableVolumetricWeight": 5,
"volumetricFactor": 3
},
"properties": {
"minimunAcceptableVolumetricWeight": {
"description": "",
"example": 0,
"title": "minimunAcceptableVolumetricWeight",
"type": "number"
},
"volumetricFactor": {
"description": "Factor that will be used on the cubic weight calculation.",
"example": 0,
"title": "volumetricFactor",
"type": "number"
}
},
"required": [
"volumetricFactor",
"minimunAcceptableVolumetricWeight"
],
"title": "cubicWeightSettings",
"type": "object"
},
"deliveryScheduleSettings": {
"description": "Settings for the Scheduled Delivery feature.",
"example": {
"dayOfWeekForDelivery": [
{
"dayOfWeek": 2,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 5,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
}
],
"maxRangeDelivery": 5,
"useDeliverySchedule": true
},
"properties": {
"dayOfWeekForDelivery": {
"description": "Select the chosen days for delivery. Values for each day of the week are: 0 = sunday, 1 = monday, 2 = tuesday, 3 = wednesday, 4 = thursday, 5 = friday, 6 = saturday. Make sure to add the available hours for the chosen days, following the example.",
"example": [
{
"dayOfWeek": 2,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
],
"maxRangeDelivery": 5
}
],
"items": {
"properties": {
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 2,
"type": "integer"
},
"deliveryRanges": {
"description": "Reservation windows for scheduled delivery.",
"items": {
"properties": {
"deliveryCapacity": {
"description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
"items": {
"example": {
"capacityType": "ORDERS_QUANTITY",
"maxValue": 55
},
"properties": {
"capacityType": {
"description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
"example": "ORDERS_QUANTITY",
"type": "string"
},
"maxValue": {
"description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
"example": 0,
"type": "number"
}
},
"required": [
"capacityType",
"maxValue"
],
"type": "object"
},
"type": "array"
},
"endTime": {
"description": "End time for day of the week.",
"example": "12:30:00",
"type": "string"
},
"listPrice": {
"description": "List price for day of the week.",
"example": 0,
"type": "number"
},
"startTime": {
"description": "Start time for day of the week.",
"example": "11:00:00",
"title": "startTime",
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"type": "object"
},
"title": "dayOfWeekForDelivery",
"type": "array"
},
"maxRangeDelivery": {
"description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.",
"example": 0,
"title": "maxRangeDelivery",
"type": "number"
},
"useDeliverySchedule": {
"description": "Select the Scheduled Delivery configuration.",
"example": true,
"title": "useDeliverySchedule",
"type": "boolean"
}
},
"required": [
"useDeliverySchedule",
"dayOfWeekForDelivery",
"maxRangeDelivery"
],
"title": "deliveryScheduleSettings",
"type": "object"
},
"id": {
"description": "ID of the shipping policy.",
"example": "123",
"title": "id schema",
"type": "string"
},
"isActive": {
"description": "Indicates whether shipping policy is active or not.",
"example": false,
"type": "boolean"
},
"maxDimension": {
"description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).",
"example": {
"largestMeasure": 15,
"maxMeasureSum": 25
},
"properties": {
"largestMeasure": {
"description": "Largest measure of the package.",
"example": 0,
"title": "largestMeasure",
"type": "number"
},
"maxMeasureSum": {
"description": "Sum of all maximum measures of the package.",
"example": 0,
"title": "maxMeasureSum",
"type": "number"
}
},
"required": [
"largestMeasure",
"maxMeasureSum"
],
"title": "maxDimension",
"type": "object"
},
"maximumValueAceptable": {
"description": "Maximum value accepted by the carrier, to realize the shipping.",
"example": 0,
"title": "maximumValueAceptable",
"type": "number"
},
"minimumValueAceptable": {
"description": "Minimum value accepted by the carrier, to realize the shipping.",
"example": 0,
"title": "minimumValueAceptable",
"type": "number"
},
"modalSettings": {
"description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.",
"example": {
"modals": [
"Modal1"
],
"useOnlyItemsWithDefinedModal": false
},
"properties": {
"modals": {
"description": "Type of special freight.",
"example": [
"Modal1"
],
"items": {},
"title": "modals",
"type": "array"
},
"useOnlyItemsWithDefinedModal": {
"description": "When set as `true`, the modal's configurations will apply only for items with a defined modal.",
"example": false,
"title": "useOnlyItemsWithDefinedModal",
"type": "boolean"
}
},
"required": [
"modals",
"useOnlyItemsWithDefinedModal"
],
"title": "modalSettings",
"type": "object"
},
"name": {
"description": "Name of the shipping policy.",
"example": "Normal",
"title": "name",
"type": "string"
},
"numberOfItemsPerShipment": {
"description": "Capacity of your store's logistics of shipment, determines number of items permitted per shipment.",
"example": 5,
"title": "numberOfItemsPerShipment",
"type": "integer"
},
"pickupPointsSettings": {
"description": "Configuration for Pickup Points.",
"example": {
"pickupPointIds": [
"null"
],
"pickupPointTags": [
"null"
],
"sellers": [
"cosmetics2"
]
},
"properties": {
"pickupPointIds": {
"description": "Insert the IDs for pickup points previously configured in your store.",
"example": [
"Id1",
"Id2"
],
"items": {},
"title": "pickupPointIds",
"type": "array"
},
"pickupPointTags": {
"description": "Insert the tags for pickup points previously configured in your store.",
"example": [
"Tag1",
"Tag2"
],
"items": {},
"title": "pickupPointTags",
"type": "array"
},
"sellers": {
"description": "Sellers that will be associated with the [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of the shipping policy being created.",
"example": [
"Seller1"
],
"items": {},
"title": "sellers",
"type": "array"
}
},
"required": [
"pickupPointIds",
"pickupPointTags",
"sellers"
],
"title": "pickupPointsSettings",
"type": "object"
},
"shippingMethod": {
"description": "Type of shipping available for this shipping policy (carrier). Options shown on freight simulation",
"example": "Normal",
"title": "shippingMethod",
"type": "string"
},
"weekendAndHolidays": {
"description": "If the shipping policy includes deliveries on weekends and holidays.",
"example": {
"holiday": false,
"saturday": false,
"sunday": false
},
"properties": {
"holiday": {
"description": "Does the shipping policy allow deliveries onholidays?",
"example": false,
"title": "holiday",
"type": "boolean"
},
"saturday": {
"description": "Does the shipping policy allow deliveries on saturdays?",
"example": false,
"title": "saturday",
"type": "boolean"
},
"sunday": {
"description": "Does the shipping policy allow deliveries on sundays?",
"example": false,
"title": "sunday",
"type": "boolean"
}
},
"required": [
"saturday",
"sunday",
"holiday"
],
"title": "weekendAndHolidays",
"type": "object"
}
},
"required": [
"id",
"name",
"shippingMethod",
"weekendAndHolidays",
"maxDimension",
"numberOfItemsPerShipment",
"minimumValueAceptable",
"maximumValueAceptable",
"deliveryScheduleSettings",
"cubicWeightSettings",
"modalSettings",
"businessHourSettings",
"pickupPointsSettings",
"isActive"
],
"title": "Request body",
"type": "object"
}
}
},
"description": ""
},
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Create shipping policy",
"tags": [
"Shipping Policies"
]
}
},
"/api/logistics/pvt/shipping-policies/{id}": {
"delete": {
"description": "This endpoint deletes existing shipping policies from carriers in your store, searching by their IDs.",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the shipping policy.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "id",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete shipping policies by ID",
"tags": [
"Shipping Policies"
]
},
"get": {
"description": "This endpoint lists existing [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from carriers in your store, searching by their IDs.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "ID of the shipping policy.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "id",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Retrieve shipping policy by ID",
"tags": [
"Shipping Policies"
]
},
"put": {
"description": "This endpoint updates information on existing Shipping Policies from carriers.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.",
"parameters": [
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Type of the content being sent",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Shipping policy's ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "shippingpolicyid1",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"deliveryOnWeekends": {
"description": "If the shipping policy (carrier) delivers on weekends",
"example": false,
"title": "deliveryOnWeekends",
"type": "boolean"
},
"deliveryScheduleSettings": {
"description": "Settings for the Scheduled Delivery feature.",
"properties": {
"dayOfWeekForDelivery": {
"description": "Select the chosen days for delivery. Values for each day of the week are: 0 = sunday, 1 = monday, 2 = tuesday, 3 = wednesday, 4 = thursday, 5 = friday, 6 = saturday. Make sure to add the available hours for the chosen days, following the example.",
"items": {
"properties": {
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 2,
"type": "integer"
},
"deliveryRanges": {
"description": "Reservation windows for scheduled delivery.",
"items": {
"properties": {
"deliveryCapacity": {
"description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
"items": {
"example": {
"capacityType": "ORDERS_QUANTITY",
"maxValue": 55
},
"properties": {
"capacityType": {
"description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
"example": "ORDERS_QUANTITY",
"type": "string"
},
"maxValue": {
"description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
"example": 0,
"type": "number"
}
},
"required": [
"capacityType",
"maxValue"
],
"type": "object"
},
"type": "array"
},
"endTime": {
"description": "End time for day of the week.",
"example": "12:30:00",
"type": "string"
},
"listPrice": {
"description": "List price for day of the week.",
"example": 0,
"type": "number"
},
"startTime": {
"description": "Start time for day of the week.",
"example": "11:00:00",
"title": "startTime",
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"type": "object"
},
"type": "array"
},
"maxRangeDelivery": {
"description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.",
"example": 0,
"type": "number"
},
"useDeliverySchedule": {
"description": "Select the Scheduled Delivery configuration.",
"example": true,
"type": "boolean"
}
},
"required": [
"useDeliverySchedule",
"dayOfWeekForDelivery",
"maxRangeDelivery"
],
"type": "object"
},
"isActive": {
"description": "If the shipping policy is active or not.",
"example": true,
"title": "isActive",
"type": "boolean"
},
"maxDimension": {
"description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).",
"example": {
"largestMeasure": 10,
"maxMeasureSum": 30
},
"properties": {
"largestMeasure": {
"description": "Largest measure of the package.",
"example": 0,
"title": "largestMeasure",
"type": "number"
},
"maxMeasureSum": {
"description": "Sum of all maximum measures of the package.",
"example": 0,
"title": "maxMeasureSum",
"type": "number"
}
},
"required": [
"largestMeasure",
"maxMeasureSum"
],
"title": "maxDimension",
"type": "object"
},
"name": {
"description": "Name of the shipping policy",
"example": "Correios PAC",
"title": "name",
"type": "string"
},
"shippingMethod": {
"description": "Type of shipping available for this shipping policy (carrier). Options shown on freight simulation.",
"example": "Normal",
"title": "shippingMethod",
"type": "string"
}
},
"required": [
"name",
"shippingMethod",
"deliveryOnWeekends",
"maxDimension",
"isActive"
],
"title": "Request body",
"type": "object"
}
}
},
"description": ""
},
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Update shipping policy",
"tags": [
"Shipping Policies"
]
}
},
"/api/logistics/pvt/shipping/calculate": {
"post": {
"deprecated": false,
"description": "Endpoint used by the checkout to calculate the Service Level Agreement (SLA), a contract between the store and shoppers on the order's fulfillment conditions, such as the shipping estimated date. \r\n\r\nThe calculation of the estimated date considers the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) and [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the order.",
"operationId": "CalculateSLA",
"parameters": [
{
"description": "Type of the content being sent.",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"default": "application/json; charset=utf-8",
"type": "string"
},
"style": "simple"
},
{
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"default": "application/json",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"example": [
{
"items": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "1",
"kitItem": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
}
],
"price": 0,
"quantity": 1
}
],
"location": {
"country": "BRA",
"point": [
-43.32475950000003,
-22.9999575
],
"zipCode": "22780084"
},
"salesChannel": "1"
}
],
"schema": {
"description": "",
"items": {
"example": {
"items": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "1",
"kitItem": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
}
],
"price": 0,
"quantity": 1
}
],
"location": {
"country": "BRA",
"point": [
-43.32475950000003,
-22.9999575
],
"zipCode": "22780084"
},
"salesChannel": "1"
},
"properties": {
"items": {
"description": "",
"items": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "1",
"kitItem": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
}
],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "KitItem",
"type": "object"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "Item3",
"type": "object"
},
"type": "array"
},
"location": {
"example": {
"country": "BRA",
"point": [
-43.32475950000003,
-22.9999575
],
"zipCode": "22780084"
},
"properties": {
"country": {
"type": "string"
},
"point": {
"description": "",
"items": {
"type": "number"
},
"type": "array"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"point"
],
"title": "Location3",
"type": "object"
},
"salesChannel": {
"type": "string"
}
},
"required": [
"items",
"location",
"salesChannel"
],
"title": "CalculateSLARequest",
"type": "object"
},
"type": "array"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": [
[
{
"aditionalTimeBlockedDays": "00:00:00",
"availabilityQuantity": 500,
"carrierSchedule": [],
"coordinates": null,
"deliveryOnWeekends": false,
"deliveryWindows": [
{
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-20T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-21T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-21T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-22T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-22T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-23T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-23T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-24T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-24T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-25T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-25T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-26T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-26T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T12:01:00+00:00"
}
],
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "teste1",
"freightTableName": "Entrega Agendada",
"itemId": "2389945",
"listPrice": 5.25,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"quantity": 1,
"restrictedFreight": null,
"salesChannel": "1",
"slaType": "Entrega Agendada",
"slaTypeName": "Entrega Agendada",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054"
},
{
"aditionalTimeBlockedDays": "00:00:00",
"availabilityQuantity": 500,
"carrierSchedule": [],
"coordinates": null,
"deliveryOnWeekends": false,
"deliveryWindows": [
{
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-20T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-21T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-21T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-22T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-22T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-23T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-23T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-24T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-24T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-25T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-25T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-26T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-26T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T12:01:00+00:00"
}
],
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "teste1",
"freightTableName": "Entrega Agendada",
"itemId": "2390059",
"listPrice": 5.25,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"quantity": 1,
"restrictedFreight": null,
"salesChannel": "1",
"slaType": "Entrega Agendada",
"slaTypeName": "Entrega Agendada",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054"
},
{
"aditionalTimeBlockedDays": "00:00:00",
"availabilityQuantity": 500,
"carrierSchedule": [],
"coordinates": null,
"deliveryOnWeekends": true,
"deliveryWindows": [],
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"itemId": "2389945",
"listPrice": 7.88,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"quantity": 1,
"restrictedFreight": null,
"salesChannel": "1",
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054"
},
{
"aditionalTimeBlockedDays": "00:00:00",
"availabilityQuantity": 500,
"carrierSchedule": [],
"coordinates": null,
"deliveryOnWeekends": true,
"deliveryWindows": [],
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"itemId": "2390059",
"listPrice": 7.88,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"quantity": 1,
"restrictedFreight": null,
"salesChannel": "1",
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054"
}
]
],
"schema": {
"items": {
"items": {
"example": {
"aditionalTimeBlockedDays": "00:00:00",
"availabilityQuantity": 500,
"carrierSchedule": [],
"coordinates": null,
"deliveryOnWeekends": false,
"deliveryWindows": [
{
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-20T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-21T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-21T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-22T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-22T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-23T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-23T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-24T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-24T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-25T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-25T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-26T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-26T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T12:01:00+00:00"
}
],
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "teste1",
"freightTableName": "Entrega Agendada",
"itemId": "2389945",
"listPrice": 5.25,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"quantity": 1,
"restrictedFreight": null,
"salesChannel": "1",
"slaType": "Entrega Agendada",
"slaTypeName": "Entrega Agendada",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054"
},
"properties": {
"aditionalTimeBlockedDays": {
"type": "string"
},
"availabilityQuantity": {
"format": "int32",
"type": "integer"
},
"carrierSchedule": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"coordinates": {
"nullable": true,
"type": "string"
},
"deliveryOnWeekends": {
"type": "boolean"
},
"deliveryWindows": {
"description": "",
"items": {
"example": {
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T08:00:00+00:00"
},
"properties": {
"endDateUtc": {
"type": "string"
},
"listPrice": {
"type": "number"
},
"startDateUtc": {
"type": "string"
}
},
"title": "DeliveryWindow",
"type": "object"
},
"type": "array"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"freightTableId": {
"type": "string"
},
"freightTableName": {
"type": "string"
},
"itemId": {
"type": "string"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"deliveryPointId": {
"nullable": true,
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"point": {
"nullable": true,
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"deliveryPointId",
"point",
"inStore"
],
"title": "Location1",
"type": "object"
},
"pickupStoreInfo": {
"nullable": true,
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"restrictedFreight": {
"nullable": true,
"type": "string"
},
"salesChannel": {
"type": "string"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"type": "string"
}
},
"required": [
"itemId",
"quantity",
"availabilityQuantity",
"salesChannel",
"slaType",
"slaTypeName",
"freightTableName",
"freightTableId",
"listPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"aditionalTimeBlockedDays",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"location",
"deliveryOnWeekends",
"carrierSchedule",
"restrictedFreight",
"coordinates",
"pickupStoreInfo"
],
"type": "object"
},
"type": "array"
},
"type": "array"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"example": "gzip",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "632",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 20:00:26 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "nginx",
"schema": {
"type": "string"
}
}
}
},
"Vary": {
"content": {
"text/plain": {
"example": "Accept-Encoding",
"schema": {
"type": "string"
}
}
}
},
"X-CDNIgnore": {
"content": {
"text/plain": {
"example": "1",
"schema": {
"type": "string"
}
}
}
},
"X-CacheServer": {
"content": {
"text/plain": {
"example": "janus-apicache-nginx1",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-ApiCache": {
"content": {
"text/plain": {
"example": "v1.3.8",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Edge": {
"content": {
"text/plain": {
"example": "v1.26.4",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-by-VTEX-Janus-Router": {
"content": {
"text/plain": {
"example": "2.1.155",
"schema": {
"type": "string"
}
}
}
},
"X-Track": {
"content": {
"text/plain": {
"example": "stable",
"schema": {
"type": "string"
}
}
}
},
"X-VTEX-Janus-Router-Backend-App": {
"content": {
"text/plain": {
"example": "logist-v6.2.96-stable+863",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "0c124229-3bb5-4fc2-9d4e-94b9cbe4281f",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Calculate SLA",
"tags": [
"SLA"
]
}
}
},
"components": {
"schemas": {
"Address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": null,
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"coordinates": {
"nullable": true,
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"coordinates"
],
"title": "Address",
"type": "object"
},
"Address1": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": [
[
-43.18228090000002,
-22.9460398
]
],
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"coordinates"
],
"title": "Address1",
"type": "object"
},
"Address2": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"location": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"reference": {
"nullable": true,
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"reference",
"location"
],
"title": "Address2",
"type": "object"
},
"Address4": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.92860984802246,
"longitude": -22.92860984802246
},
"neighborhood": "Catete",
"number": "",
"postalCode": "22220070",
"state": "RJ",
"street": "Rua Artur Bernardes"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"location": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"location"
],
"title": "Address4",
"type": "object"
},
"Balance": {
"example": {
"hasUnlimitedQuantity": false,
"reservedQuantity": 9,
"totalQuantity": 101,
"warehouseId": "1937054",
"warehouseName": "Estoque A"
},
"properties": {
"hasUnlimitedQuantity": {
"type": "boolean"
},
"reservedQuantity": {
"format": "int32",
"type": "integer"
},
"totalQuantity": {
"format": "int32",
"type": "integer"
},
"warehouseId": {
"type": "string"
},
"warehouseName": {
"type": "string"
}
},
"required": [
"warehouseId",
"warehouseName",
"totalQuantity",
"reservedQuantity",
"hasUnlimitedQuantity"
],
"title": "Balance",
"type": "object"
},
"BusinessHour": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"type": "string"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"openingTime": {
"type": "string"
}
},
"required": [
"dayOfWeek",
"openingTime",
"closingTime"
],
"title": "BusinessHour",
"type": "object"
},
"CalculateSLARequest": {
"example": {
"items": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "1",
"kitItem": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
}
],
"price": 0,
"quantity": 1
}
],
"location": {
"country": "BRA",
"point": [
-43.32475950000003,
-22.9999575
],
"zipCode": "22780084"
},
"salesChannel": "1"
},
"properties": {
"items": {
"description": "",
"items": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "1",
"kitItem": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
}
],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "KitItem",
"type": "object"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "Item3",
"type": "object"
},
"type": "array"
},
"location": {
"example": {
"country": "BRA",
"point": [
-43.32475950000003,
-22.9999575
],
"zipCode": "22780084"
},
"properties": {
"country": {
"type": "string"
},
"point": {
"description": "",
"items": {
"type": "number"
},
"type": "array"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"point"
],
"title": "Location3",
"type": "object"
},
"salesChannel": {
"type": "string"
}
},
"required": [
"items",
"location",
"salesChannel"
],
"title": "CalculateSLARequest",
"type": "object"
},
"Country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"CreateReservation": {
"example": {
"AuthorizedDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"CanceledDateUtc": "0001-01-01T00:00:00+00:00",
"ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
"Errors": [],
"IsSucess": true,
"LastUpdateDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4",
"MaximumConfirmationDateUtc": "2016-04-15T20:09:20.0397988+00:00",
"PickupPointItemOptions": null,
"ReservationDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"SalesChannel": "2",
"SlaRequest": [
{
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
}
],
"Status": 1
},
"properties": {
"AuthorizedDateUtc": {
"type": "string"
},
"CanceledDateUtc": {
"type": "string"
},
"ConfirmedDateUtc": {
"type": "string"
},
"Errors": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"IsSucess": {
"type": "boolean"
},
"LastUpdateDateUtc": {
"type": "string"
},
"LockId": {
"type": "string"
},
"MaximumConfirmationDateUtc": {
"type": "string"
},
"PickupPointItemOptions": {
"nullable": true,
"type": "string"
},
"ReservationDateUtc": {
"type": "string"
},
"SalesChannel": {
"type": "string"
},
"SlaRequest": {
"description": "",
"items": {
"example": {
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
},
"properties": {
"deliveryWindows": {
"nullable": true,
"type": "string"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"freightTableId": {
"type": "string"
},
"freightTableName": {
"type": "string"
},
"item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "Dimension1",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"modal": {
"nullable": true,
"type": "string"
},
"price": {
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unlimitedQuantity": {
"type": "boolean"
}
},
"required": [
"id",
"groupItemId",
"quantity",
"price",
"modal",
"additionalHandlingTime",
"dimension",
"kitItem",
"unlimitedQuantity"
],
"title": "Item1",
"type": "object"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"deliveryPointId": {
"nullable": true,
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"point": {
"nullable": true,
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"deliveryPointId",
"point",
"inStore"
],
"title": "Location1",
"type": "object"
},
"pickupStoreInfo": {
"nullable": true,
"type": "string"
},
"promotionalPrice": {
"type": "number"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"item",
"slaType",
"slaTypeName",
"freightTableName",
"freightTableId",
"listPrice",
"promotionalPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"wmsEndPoint",
"location",
"pickupStoreInfo"
],
"title": "SlaRequest",
"type": "object"
},
"type": "array"
},
"Status": {
"format": "int32",
"type": "integer"
}
},
"required": [
"LastUpdateDateUtc",
"SalesChannel",
"LockId",
"ReservationDateUtc",
"MaximumConfirmationDateUtc",
"Status",
"SlaRequest",
"PickupPointItemOptions",
"CanceledDateUtc",
"AuthorizedDateUtc",
"ConfirmedDateUtc",
"Errors",
"IsSucess"
],
"title": "",
"type": "object"
},
"CreateReservationRequest": {
"example": {
"autorizationExpirationTTL": "00:10:00",
"deliveryItemOptions": [
{
"aditionalTimeBlockedDays": "00:00:00",
"deliveryWindows": [],
"dockId": "1a8bce3",
"dockTime": "00:00:00",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"promotionalPrice": 10.5,
"slaType": "Expressa",
"slaTypeName": "Expressa",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": null
}
],
"lockId": null,
"salesChannel": "1"
},
"properties": {
"autorizationExpirationTTL": {
"type": "string"
},
"deliveryItemOptions": {
"description": "",
"items": {
"example": {
"aditionalTimeBlockedDays": "00:00:00",
"deliveryWindows": [],
"dockId": "1a8bce3",
"dockTime": "00:00:00",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"promotionalPrice": 10.5,
"slaType": "Expressa",
"slaTypeName": "Expressa",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": null
},
"properties": {
"aditionalTimeBlockedDays": {
"type": "string"
},
"deliveryWindows": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "Item",
"type": "object"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": null
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"nullable": true,
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore",
"type": "object"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"inStore"
],
"title": "Location",
"type": "object"
},
"promotionalPrice": {
"type": "number"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"slaType",
"slaTypeName",
"listPrice",
"promotionalPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"aditionalTimeBlockedDays",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"location"
],
"title": "DeliveryItemOption",
"type": "object"
},
"type": "array"
},
"lockId": {
"nullable": true,
"type": "string"
},
"salesChannel": {
"type": "string"
}
},
"required": [
"salesChannel",
"lockId",
"autorizationExpirationTTL",
"deliveryItemOptions"
],
"title": "CreateReservationRequest",
"type": "object"
},
"CreateUpdate": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"businessHours": [
{
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 2,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 3,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 4,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 5,
"openingTime": "08:00:00"
}
],
"description": "",
"formatted_address": "undefined",
"id": "rteste",
"instructions": "Obrigatório apresentar documento de identificação",
"isActive": true,
"name": "Loja Copacabana",
"pickupHolidays": [],
"tagsLabel": [
"zonasul",
"rio de janeiro"
]
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"location": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"reference": {
"nullable": true,
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"reference",
"location"
],
"title": "Address2",
"type": "object"
},
"businessHours": {
"description": "",
"items": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"type": "string"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"openingTime": {
"type": "string"
}
},
"required": [
"dayOfWeek",
"openingTime",
"closingTime"
],
"title": "BusinessHour",
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"formatted_address": {
"type": "string"
},
"id": {
"type": "string"
},
"instructions": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"name": {
"type": "string"
},
"pickupHolidays": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"tagsLabel": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"instructions",
"formatted_address",
"address",
"isActive",
"businessHours",
"tagsLabel",
"pickupHolidays"
],
"title": "Create/Update",
"type": "object"
},
"CreateUpdateCarrierDeliveryWindowsRequest": {
"example": {
"carrierSchedule": [],
"dayOfWeekForDelivery": [
{
"dayOfWeek": 0,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
{
"dayOfWeek": 1,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
{
"dayOfWeek": 2,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
{
"dayOfWeek": 3,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
{
"dayOfWeek": 4,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
{
"dayOfWeek": 5,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
{
"dayOfWeek": 6,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
}
],
"deliveryOnWeekends": false,
"factorCubicWeight": null,
"id": "11cc4b5",
"maxDimension": {
"height": null,
"length": null,
"maxSumDimension": null
},
"maxRangeDelivery": 7,
"minimunCubicWeight": null,
"modals": [],
"name": "Entrega Agendada",
"numberOfItemsPerShipment": null,
"onlyItemsWithDefinedModal": false,
"scheduledDelivery": true,
"slaType": "Entrega Agendada"
},
"properties": {
"carrierSchedule": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dayOfWeekForDelivery": {
"description": "Select the chosen days for delivery. Values for each day of the week are: 0 = sunday, 1 = monday, 2 = tuesday, 3 = wednesday, 4 = thursday, 5 = friday, 6 = saturday. Make sure to add the available hours for the chosen days, following the example.",
"items": {
"properties": {
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 2,
"type": "integer"
},
"deliveryRanges": {
"description": "Reservation windows for scheduled delivery.",
"items": {
"properties": {
"deliveryCapacity": {
"description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
"items": {
"example": {
"capacityType": "ORDERS_QUANTITY",
"maxValue": 55
},
"properties": {
"capacityType": {
"description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
"example": "ORDERS_QUANTITY",
"type": "string"
},
"maxValue": {
"description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
"example": 0,
"type": "number"
}
},
"required": [
"capacityType",
"maxValue"
],
"type": "object"
},
"type": "array"
},
"endTime": {
"description": "End time for day of the week.",
"example": "12:30:00",
"type": "string"
},
"listPrice": {
"description": "List price for day of the week.",
"example": 0,
"type": "number"
},
"startTime": {
"description": "Start time for day of the week.",
"example": "11:00:00",
"title": "startTime",
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"type": "object"
},
"type": "array"
},
"deliveryOnWeekends": {
"type": "boolean"
},
"factorCubicWeight": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"maxDimension": {
"example": {
"height": null,
"length": null,
"maxSumDimension": null
},
"properties": {
"height": {
"nullable": true,
"type": "string"
},
"length": {
"nullable": true,
"type": "string"
},
"maxSumDimension": {
"nullable": true,
"type": "string"
}
},
"required": [
"maxSumDimension",
"height",
"length"
],
"title": "MaxDimension1",
"type": "object"
},
"maxRangeDelivery": {
"format": "int32",
"type": "integer"
},
"minimunCubicWeight": {
"nullable": true,
"type": "string"
},
"modals": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"numberOfItemsPerShipment": {
"nullable": true,
"type": "string"
},
"onlyItemsWithDefinedModal": {
"type": "boolean"
},
"scheduledDelivery": {
"type": "boolean"
},
"slaType": {
"type": "string"
}
},
"required": [
"id",
"name",
"slaType",
"factorCubicWeight",
"minimunCubicWeight",
"numberOfItemsPerShipment",
"modals",
"onlyItemsWithDefinedModal",
"maxDimension",
"scheduledDelivery",
"maxRangeDelivery",
"dayOfWeekForDelivery",
"deliveryOnWeekends",
"carrierSchedule"
],
"title": "Create/UpdateCarrier(DeliveryWindows)Request",
"type": "object"
},
"CreateUpdateCarrierRequest": {
"example": {
"carrierSchedule": [],
"dayOfWeekBlockeds": [],
"dayOfWeekForDelivery": null,
"deliveryOnWeekends": false,
"exclusiveToDeliveryPoints": false,
"factorCubicWeight": null,
"freightTableProcessStatus": 1,
"freightTableValueError": null,
"freightValue": [],
"id": "13942e4",
"isPolygon": false,
"maxDimension": {
"height": 0,
"length": 0,
"maxSumDimension": 0,
"weight": 0,
"width": 0
},
"maxRangeDelivery": 0,
"minimunCubicWeight": 0,
"modals": [],
"name": "Transportadora Expressa",
"numberOfItemsPerShipment": null,
"onlyItemsWithDefinedModal": false,
"scheduledDelivery": false,
"slaType": "Expressa"
},
"properties": {
"carrierSchedule": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dayOfWeekBlockeds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dayOfWeekForDelivery": {
"description": "Select the chosen days for delivery. Values for each day of the week are: 0 = sunday, 1 = monday, 2 = tuesday, 3 = wednesday, 4 = thursday, 5 = friday, 6 = saturday. Make sure to add the available hours for the chosen days, following the example.",
"items": {
"properties": {
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 2,
"type": "integer"
},
"deliveryRanges": {
"description": "Reservation windows for scheduled delivery.",
"items": {
"properties": {
"deliveryCapacity": {
"description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
"items": {
"example": {
"capacityType": "ORDERS_QUANTITY",
"maxValue": 55
},
"properties": {
"capacityType": {
"description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
"example": "ORDERS_QUANTITY",
"type": "string"
},
"maxValue": {
"description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
"example": 0,
"type": "number"
}
},
"required": [
"capacityType",
"maxValue"
],
"type": "object"
},
"type": "array"
},
"endTime": {
"description": "End time for day of the week.",
"example": "12:30:00",
"type": "string"
},
"listPrice": {
"description": "List price for day of the week.",
"example": 0,
"type": "number"
},
"startTime": {
"description": "Start time for day of the week.",
"example": "11:00:00",
"title": "startTime",
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"type": "object"
},
"nullable": true,
"type": "array"
},
"deliveryOnWeekends": {
"type": "boolean"
},
"exclusiveToDeliveryPoints": {
"type": "boolean"
},
"factorCubicWeight": {
"nullable": true,
"type": "string"
},
"freightTableProcessStatus": {
"format": "int32",
"type": "integer"
},
"freightTableValueError": {
"nullable": true,
"type": "string"
},
"freightValue": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"isPolygon": {
"type": "boolean"
},
"maxDimension": {
"example": {
"height": 0,
"length": 0,
"maxSumDimension": 0,
"weight": 0,
"width": 0
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"maxSumDimension": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "MaxDimension",
"type": "object"
},
"maxRangeDelivery": {
"format": "int32",
"type": "integer"
},
"minimunCubicWeight": {
"format": "int32",
"type": "integer"
},
"modals": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"numberOfItemsPerShipment": {
"nullable": true,
"type": "string"
},
"onlyItemsWithDefinedModal": {
"type": "boolean"
},
"scheduledDelivery": {
"type": "boolean"
},
"slaType": {
"type": "string"
}
},
"required": [
"id",
"slaType",
"name",
"scheduledDelivery",
"maxRangeDelivery",
"dayOfWeekForDelivery",
"dayOfWeekBlockeds",
"freightValue",
"factorCubicWeight",
"freightTableProcessStatus",
"freightTableValueError",
"modals",
"onlyItemsWithDefinedModal",
"deliveryOnWeekends",
"carrierSchedule",
"maxDimension",
"exclusiveToDeliveryPoints",
"minimunCubicWeight",
"isPolygon",
"numberOfItemsPerShipment"
],
"title": "Create/UpdateCarrierRequest",
"type": "object"
},
"CreateUpdateDockRequest": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": [
[
-43.18228090000002,
-22.9460398
]
],
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"dockTimeFake": "00:00:00",
"freightTableIds": [],
"id": "catete",
"name": "Loja Catete",
"pickupStoreInfo": {
"additionalInfo": null,
"address": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": null,
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": [
[
-43.18228090000002,
-22.9460398
]
],
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"coordinates"
],
"title": "Address1",
"type": "object"
},
"dockTimeFake": {
"type": "string"
},
"freightTableIds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pickupStoreInfo": {
"example": {
"additionalInfo": null,
"address": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": null,
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"properties": {
"additionalInfo": {
"nullable": true,
"type": "string"
},
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": null,
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"coordinates": {
"nullable": true,
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"coordinates"
],
"title": "Address",
"type": "object"
},
"dockId": {
"nullable": true,
"type": "string"
},
"friendlyName": {
"nullable": true,
"type": "string"
},
"isPickupStore": {
"type": "boolean"
},
"storeId": {
"nullable": true,
"type": "string"
}
},
"required": [
"isPickupStore",
"storeId",
"friendlyName",
"address",
"additionalInfo",
"dockId"
],
"title": "PickupStoreInfo",
"type": "object"
},
"priority": {
"format": "int32",
"type": "integer"
},
"salesChannel": {
"nullable": true,
"type": "string"
},
"salesChannels": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"timeFakeOverhead": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"id",
"name",
"priority",
"dockTimeFake",
"timeFakeOverhead",
"salesChannels",
"salesChannel",
"freightTableIds",
"wmsEndPoint",
"pickupStoreInfo",
"address"
],
"title": "Create/UpdateDockRequest",
"type": "object"
},
"CreateUpdateFreightValuesRequest": {
"example": {
"absoluteMoneyCost": "1.00",
"country": "BRA",
"maxVolume": 1000000000,
"operationType": 1,
"polygon": "",
"pricePercent": 0,
"pricePercentByWeight": 0,
"timeCost": "2.00:00:00",
"weightEnd": 1000,
"weightStart": 1,
"zipCodeEnd": "99999999",
"zipCodeStart": "0"
},
"properties": {
"absoluteMoneyCost": {
"type": "string"
},
"country": {
"type": "string"
},
"maxVolume": {
"format": "int32",
"type": "integer"
},
"operationType": {
"format": "int32",
"type": "integer"
},
"polygon": {
"type": "string"
},
"pricePercent": {
"format": "int32",
"type": "integer"
},
"pricePercentByWeight": {
"format": "int32",
"type": "integer"
},
"timeCost": {
"type": "string"
},
"weightEnd": {
"format": "int32",
"type": "integer"
},
"weightStart": {
"format": "int32",
"type": "integer"
},
"zipCodeEnd": {
"type": "string"
},
"zipCodeStart": {
"type": "string"
}
},
"required": [
"absoluteMoneyCost",
"country",
"maxVolume",
"operationType",
"pricePercent",
"pricePercentByWeight",
"timeCost",
"weightEnd",
"weightStart",
"zipCodeEnd",
"zipCodeStart",
"polygon"
],
"title": "Create/UpdateFreightValuesRequest",
"type": "object"
},
"CreateUpdateHolidayRequest": {
"example": {
"name": "Natal",
"startDate": "2016-12-25"
},
"properties": {
"name": {
"type": "string"
},
"startDate": {
"type": "string"
}
},
"required": [
"name",
"startDate"
],
"title": "Create/UpdateHolidayRequest",
"type": "object"
},
"CreateUpdatePolygonRequest": {
"properties": {
"geoShape": {
"properties": {
"coordinates": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
}
},
"required": [
"coordinates"
],
"title": "GeoShape",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"geoShape"
],
"title": "Create/UpdatePolygonRequest",
"type": "object"
},
"CreateUpdateRequest": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"businessHours": [
{
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 2,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 3,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 4,
"openingTime": "08:00:00"
},
{
"closingTime": "20:00:00",
"dayOfWeek": 5,
"openingTime": "08:00:00"
}
],
"description": "",
"formatted_address": "undefined",
"id": "1a227d3",
"instructions": "Obrigatório apresentar documento de identificação",
"isActive": true,
"name": "Loja Copacabana",
"tagsLabel": [
"zonasul",
"rio de janeiro"
]
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"neighborhood": "Copacabana",
"number": "",
"postalCode": "22070002",
"reference": null,
"state": "RJ",
"street": "Avenida Atlântica"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"location": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"reference": {
"nullable": true,
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"reference",
"location"
],
"title": "Address2",
"type": "object"
},
"businessHours": {
"description": "",
"items": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"type": "string"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"openingTime": {
"type": "string"
}
},
"required": [
"dayOfWeek",
"openingTime",
"closingTime"
],
"title": "BusinessHour",
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"formatted_address": {
"type": "string"
},
"id": {
"type": "string"
},
"instructions": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"name": {
"type": "string"
},
"tagsLabel": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"instructions",
"formatted_address",
"address",
"isActive",
"businessHours",
"tagsLabel"
],
"title": "Create/UpdateRequest",
"type": "object"
},
"CreateUpdateWarehouseRequest": {
"example": {
"id": "15bfc76",
"name": "Estoque Principal",
"warehouseDocks": [
{
"cost": "5.00",
"costToDisplay": "5,00",
"dockId": "1a8bce3",
"name": "Centro de Distribuição Principal",
"time": "3.00:00:00",
"translateDays": "dias"
}
]
},
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"warehouseDocks": {
"description": "",
"items": {
"example": {
"cost": "5.00",
"costToDisplay": "5,00",
"dockId": "1a8bce3",
"name": "Centro de Distribuição Principal",
"time": "3.00:00:00",
"translateDays": "dias"
},
"properties": {
"cost": {
"type": "string"
},
"costToDisplay": {
"type": "string"
},
"dockId": {
"type": "string"
},
"name": {
"type": "string"
},
"time": {
"type": "string"
},
"translateDays": {
"type": "string"
}
},
"required": [
"dockId",
"name",
"time",
"cost",
"translateDays",
"costToDisplay"
],
"title": "WarehouseDock",
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"warehouseDocks"
],
"title": "Create/UpdateWarehouseRequest",
"type": "object"
},
"DayOfWeekForDelivery": {
"example": {
"dayOfWeek": 0,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
"properties": {
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"deliveryRanges": {
"description": "",
"items": {
"example": {
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
"properties": {
"endTime": {
"type": "string"
},
"listPrice": {
"format": "int32",
"type": "integer"
},
"startTime": {
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"title": "DeliveryRange",
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"title": "DayOfWeekForDelivery",
"type": "object"
},
"DayOfWeekForDelivery1": {
"example": {
"dayOfWeek": 0,
"deliveryRanges": [
{
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
{
"endTime": "18:00:00",
"listPrice": 10,
"startTime": "12:01:00"
}
]
},
"properties": {
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"deliveryRanges": {
"description": "",
"items": {
"example": {
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
"properties": {
"endTime": {
"type": "string"
},
"listPrice": {
"type": "number"
},
"startTime": {
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"title": "DeliveryRange1",
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"title": "DayOfWeekForDelivery1",
"type": "object"
},
"DeliveryItemOption": {
"example": {
"aditionalTimeBlockedDays": "00:00:00",
"deliveryWindows": [],
"dockId": "1a8bce3",
"dockTime": "00:00:00",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"promotionalPrice": 10.5,
"slaType": "Expressa",
"slaTypeName": "Expressa",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": null
},
"properties": {
"aditionalTimeBlockedDays": {
"type": "string"
},
"deliveryWindows": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "Item",
"type": "object"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": null
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"nullable": true,
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore",
"type": "object"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"inStore"
],
"title": "Location",
"type": "object"
},
"promotionalPrice": {
"type": "number"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"slaType",
"slaTypeName",
"listPrice",
"promotionalPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"aditionalTimeBlockedDays",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"location"
],
"title": "DeliveryItemOption",
"type": "object"
},
"DeliveryRange": {
"example": {
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
"properties": {
"endTime": {
"type": "string"
},
"listPrice": {
"format": "int32",
"type": "integer"
},
"startTime": {
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"title": "DeliveryRange",
"type": "object"
},
"DeliveryRange1": {
"example": {
"endTime": "12:00:00",
"listPrice": 10,
"startTime": "08:00:00"
},
"properties": {
"endTime": {
"type": "string"
},
"listPrice": {
"type": "number"
},
"startTime": {
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"title": "DeliveryRange1",
"type": "object"
},
"DeliveryWindow": {
"example": {
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T08:00:00+00:00"
},
"properties": {
"endDateUtc": {
"type": "string"
},
"listPrice": {
"type": "number"
},
"startDateUtc": {
"type": "string"
}
},
"title": "DeliveryWindow",
"type": "object"
},
"Dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"Dimension1": {
"example": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "Dimension1",
"type": "object"
},
"Error": {
"example": {
"code": "429",
"message": "Too many active reservation!"
},
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"title": "Error",
"type": "object"
},
"Errorbytoomanyactivereservations": {
"example": {
"error": {
"code": "429",
"message": "Too many active reservation!"
}
},
"properties": {
"error": {
"example": {
"code": "429",
"message": "Too many active reservation!"
},
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"title": "Error",
"type": "object"
}
},
"required": [
"error"
],
"title": "Errorbytoomanyactivereservations",
"type": "object"
},
"GeoShape": {
"properties": {
"coordinates": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
}
},
"required": [
"coordinates"
],
"title": "GeoShape",
"type": "object"
},
"GetById": {
"example": {
"address": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.92860984802246,
"longitude": -22.92860984802246
},
"neighborhood": "Catete",
"number": "",
"postalCode": "22220070",
"state": "RJ",
"street": "Rua Artur Bernardes"
},
"businessHours": [
{
"closingTime": "21:00:00",
"dayOfWeek": 0,
"openingTime": "11:00:00"
}
],
"description": "Loja Barra da Tijuca",
"formatted_address": "undefined",
"id": "12345",
"instructions": "Loja Barra da Tijuca",
"isActive": true,
"name": "Loja Barra da Tijuca",
"warehouseId": null
},
"properties": {
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"location": {
"latitude": -22.92860984802246,
"longitude": -22.92860984802246
},
"neighborhood": "Catete",
"number": "",
"postalCode": "22220070",
"state": "RJ",
"street": "Rua Artur Bernardes"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"location": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"location"
],
"title": "Address4",
"type": "object"
},
"businessHours": {
"description": "",
"items": {
"example": {
"closingTime": "20:00:00",
"dayOfWeek": 1,
"openingTime": "08:00:00"
},
"properties": {
"closingTime": {
"type": "string"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"openingTime": {
"type": "string"
}
},
"required": [
"dayOfWeek",
"openingTime",
"closingTime"
],
"title": "BusinessHour",
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"formatted_address": {
"type": "string"
},
"id": {
"type": "string"
},
"instructions": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"name": {
"type": "string"
},
"warehouseId": {
"nullable": true,
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"instructions",
"formatted_address",
"address",
"isActive",
"warehouseId",
"businessHours"
],
"title": "GetById",
"type": "object"
},
"InStore": {
"example": {
"IsCheckedIn": false,
"StoreId": null
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"nullable": true,
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore",
"type": "object"
},
"InStore1": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"Item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "Item",
"type": "object"
},
"Item1": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "Dimension1",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"modal": {
"nullable": true,
"type": "string"
},
"price": {
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unlimitedQuantity": {
"type": "boolean"
}
},
"required": [
"id",
"groupItemId",
"quantity",
"price",
"modal",
"additionalHandlingTime",
"dimension",
"kitItem",
"unlimitedQuantity"
],
"title": "Item1",
"type": "object"
},
"Item3": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "1",
"kitItem": [
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
{
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"price": 0,
"quantity": 1
}
],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "KitItem",
"type": "object"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "Item3",
"type": "object"
},
"KitItem": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 5,
"length": 17,
"weight": 150,
"width": 17
},
"groupItemId": null,
"id": "2000042",
"kitItem": [],
"price": 0,
"quantity": 1
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 1,
"length": 1,
"weight": 150,
"width": 1
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length"
],
"title": "Dimension",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"format": "int32",
"type": "integer"
},
"quantity": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"groupItemId",
"kitItem",
"quantity",
"price",
"additionalHandlingTime",
"dimension"
],
"title": "KitItem",
"type": "object"
},
"ListAllAarehouses": {
"example": {
"id": "1937054",
"name": "Estoque A",
"warehouseDocks": [
{
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
}
]
},
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"warehouseDocks": {
"description": "",
"items": {
"example": {
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
},
"properties": {
"cost": {
"type": "number"
},
"dockId": {
"type": "string"
},
"time": {
"type": "string"
}
},
"required": [
"dockId",
"time",
"cost"
],
"title": "WarehouseDock1",
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"warehouseDocks"
],
"title": "",
"type": "object"
},
"ListAllDocks": {
"example": {
"dockTimeFake": "1.00:00:00",
"freightTableIds": [
"11cc4b6",
"teste1",
"186a2a6",
"1962962",
"173a63f"
],
"id": "1a8bce3",
"name": "Centro de Distribuição Principal",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"priority": 0,
"salesChannel": null,
"salesChannels": [
"1",
"2"
],
"timeFakeOverhead": "00:00:00",
"wmsEndPoint": ""
},
"properties": {
"dockTimeFake": {
"type": "string"
},
"freightTableIds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pickupStoreInfo": {
"example": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"properties": {
"additionalInfo": {
"nullable": true,
"type": "string"
},
"address": {
"nullable": true,
"type": "string"
},
"dockId": {
"nullable": true,
"type": "string"
},
"friendlyName": {
"nullable": true,
"type": "string"
},
"isPickupStore": {
"type": "boolean"
},
"storeId": {
"nullable": true,
"type": "string"
}
},
"required": [
"isPickupStore",
"storeId",
"friendlyName",
"address",
"additionalInfo",
"dockId"
],
"title": "PickupStoreInfo1",
"type": "object"
},
"priority": {
"format": "int32",
"type": "integer"
},
"salesChannel": {
"nullable": true,
"type": "string"
},
"salesChannels": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"timeFakeOverhead": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"id",
"name",
"priority",
"dockTimeFake",
"timeFakeOverhead",
"salesChannels",
"salesChannel",
"freightTableIds",
"wmsEndPoint",
"pickupStoreInfo"
],
"title": "",
"type": "object"
},
"ListFreightValues": {
"example": {
"absoluteMoneyCost": 1,
"country": "BRA",
"maxVolume": 1000000000,
"minimumValueInsurance": 0,
"operationType": 0,
"polygon": "",
"pricePercent": 0,
"pricePercentByWeight": 0,
"restrictedFreights": [],
"timeCost": "2.00:00:00",
"weightEnd": 1000,
"weightStart": 1,
"zipCodeEnd": "99999999",
"zipCodeStart": "0"
},
"properties": {
"absoluteMoneyCost": {
"type": "number"
},
"country": {
"type": "string"
},
"maxVolume": {
"type": "number"
},
"minimumValueInsurance": {
"type": "number"
},
"operationType": {
"format": "int32",
"type": "integer"
},
"polygon": {
"type": "string"
},
"pricePercent": {
"type": "number"
},
"pricePercentByWeight": {
"type": "number"
},
"restrictedFreights": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"timeCost": {
"type": "string"
},
"weightEnd": {
"type": "number"
},
"weightStart": {
"type": "number"
},
"zipCodeEnd": {
"type": "string"
},
"zipCodeStart": {
"type": "string"
}
},
"required": [
"zipCodeStart",
"zipCodeEnd",
"weightStart",
"weightEnd",
"absoluteMoneyCost",
"pricePercent",
"pricePercentByWeight",
"maxVolume",
"timeCost",
"country",
"operationType",
"restrictedFreights",
"polygon",
"minimumValueInsurance"
],
"title": "",
"type": "object"
},
"ListInventoryBySKU": {
"example": {
"balance": [
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 9,
"totalQuantity": 101,
"warehouseId": "1937054",
"warehouseName": "Estoque A"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "avl",
"warehouseName": "Estoque InStore"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "1448dc2",
"warehouseName": "Estoque C"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "140ac66",
"warehouseName": "Estoque B"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 100,
"warehouseId": "pickuppoint",
"warehouseName": "PickupPoint"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 200,
"warehouseId": "pickuppoint_2",
"warehouseName": "PickupPoint 2"
},
{
"hasUnlimitedQuantity": false,
"reservedQuantity": 0,
"totalQuantity": 1011,
"warehouseId": "15bfc76",
"warehouseName": "Estoque Principal"
}
],
"skuId": "2390059"
},
"properties": {
"balance": {
"description": "",
"items": {
"example": {
"hasUnlimitedQuantity": false,
"reservedQuantity": 9,
"totalQuantity": 101,
"warehouseId": "1937054",
"warehouseName": "Estoque A"
},
"properties": {
"hasUnlimitedQuantity": {
"type": "boolean"
},
"reservedQuantity": {
"format": "int32",
"type": "integer"
},
"totalQuantity": {
"format": "int32",
"type": "integer"
},
"warehouseId": {
"type": "string"
},
"warehouseName": {
"type": "string"
}
},
"required": [
"warehouseId",
"warehouseName",
"totalQuantity",
"reservedQuantity",
"hasUnlimitedQuantity"
],
"title": "Balance",
"type": "object"
},
"type": "array"
},
"skuId": {
"type": "string"
}
},
"required": [
"skuId",
"balance"
],
"title": "",
"type": "object"
},
"ListReservationByWarehouseAndSKU": {
"example": {
"aditionalTimeBlockedDays": "00:00:00",
"availabilityQuantity": 500,
"carrierSchedule": [],
"coordinates": null,
"deliveryOnWeekends": false,
"deliveryWindows": [
{
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-20T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-21T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-21T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-21T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-22T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-22T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-22T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-23T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-23T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-23T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-24T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-24T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-24T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-25T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-25T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-25T12:01:00+00:00"
},
{
"endDateUtc": "2016-04-26T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T08:00:00+00:00"
},
{
"endDateUtc": "2016-04-26T18:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-26T12:01:00+00:00"
}
],
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "teste1",
"freightTableName": "Entrega Agendada",
"itemId": "2389945",
"listPrice": 5.25,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"quantity": 1,
"restrictedFreight": null,
"salesChannel": "1",
"slaType": "Entrega Agendada",
"slaTypeName": "Entrega Agendada",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054"
},
"properties": {
"aditionalTimeBlockedDays": {
"type": "string"
},
"availabilityQuantity": {
"format": "int32",
"type": "integer"
},
"carrierSchedule": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"coordinates": {
"nullable": true,
"type": "string"
},
"deliveryOnWeekends": {
"type": "boolean"
},
"deliveryWindows": {
"description": "",
"items": {
"example": {
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10,
"startDateUtc": "2016-04-20T08:00:00+00:00"
},
"properties": {
"endDateUtc": {
"type": "string"
},
"listPrice": {
"type": "number"
},
"startDateUtc": {
"type": "string"
}
},
"title": "DeliveryWindow",
"type": "object"
},
"type": "array"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"freightTableId": {
"type": "string"
},
"freightTableName": {
"type": "string"
},
"itemId": {
"type": "string"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"deliveryPointId": {
"nullable": true,
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"point": {
"nullable": true,
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"deliveryPointId",
"point",
"inStore"
],
"title": "Location1",
"type": "object"
},
"pickupStoreInfo": {
"nullable": true,
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"restrictedFreight": {
"nullable": true,
"type": "string"
},
"salesChannel": {
"type": "string"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"type": "string"
}
},
"required": [
"itemId",
"quantity",
"availabilityQuantity",
"salesChannel",
"slaType",
"slaTypeName",
"freightTableName",
"freightTableId",
"listPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"aditionalTimeBlockedDays",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"location",
"deliveryOnWeekends",
"carrierSchedule",
"restrictedFreight",
"coordinates",
"pickupStoreInfo"
],
"title": "",
"type": "object"
},
"Location": {
"example": {
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
},
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": null
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"nullable": true,
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore",
"type": "object"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"inStore"
],
"title": "Location",
"type": "object"
},
"Location1": {
"example": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"deliveryPointId": {
"nullable": true,
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"point": {
"nullable": true,
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"deliveryPointId",
"point",
"inStore"
],
"title": "Location1",
"type": "object"
},
"Location3": {
"example": {
"country": "BRA",
"point": [
-43.32475950000003,
-22.9999575
],
"zipCode": "22780084"
},
"properties": {
"country": {
"type": "string"
},
"point": {
"description": "",
"items": {
"type": "number"
},
"type": "array"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"point"
],
"title": "Location3",
"type": "object"
},
"Location5": {
"example": {
"latitude": -22.974477767944336,
"longitude": -43.18672561645508
},
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"title": "Location5",
"type": "object"
},
"MaxDimension": {
"example": {
"height": 0,
"length": 0,
"maxSumDimension": 0,
"weight": 0,
"width": 0
},
"properties": {
"height": {
"format": "int32",
"type": "integer"
},
"length": {
"format": "int32",
"type": "integer"
},
"maxSumDimension": {
"format": "int32",
"type": "integer"
},
"weight": {
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "MaxDimension",
"type": "object"
},
"MaxDimension1": {
"example": {
"height": null,
"length": null,
"maxSumDimension": null
},
"properties": {
"height": {
"nullable": true,
"type": "string"
},
"length": {
"nullable": true,
"type": "string"
},
"maxSumDimension": {
"nullable": true,
"type": "string"
}
},
"required": [
"maxSumDimension",
"height",
"length"
],
"title": "MaxDimension1",
"type": "object"
},
"MaxDimension2": {
"example": {
"height": 110,
"length": 110,
"maxSumDimension": 200,
"weight": 0,
"width": 110
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "MaxDimension2",
"type": "object"
},
"PickupStoreInfo": {
"example": {
"additionalInfo": null,
"address": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": null,
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"properties": {
"additionalInfo": {
"nullable": true,
"type": "string"
},
"address": {
"example": {
"city": "Rio de Janeiro",
"complement": "",
"coordinates": null,
"country": {
"acronym": "BRA",
"name": "Brazil"
},
"neighborhood": "Catete",
"number": "100",
"postalCode": "22220070",
"state": "RJ",
"street": "Artur Bernardes Street"
},
"properties": {
"city": {
"type": "string"
},
"complement": {
"type": "string"
},
"coordinates": {
"nullable": true,
"type": "string"
},
"country": {
"example": {
"acronym": "BRA",
"name": "Brazil"
},
"properties": {
"acronym": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"acronym",
"name"
],
"title": "Country",
"type": "object"
},
"neighborhood": {
"type": "string"
},
"number": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"postalCode",
"country",
"city",
"state",
"neighborhood",
"street",
"number",
"complement",
"coordinates"
],
"title": "Address",
"type": "object"
},
"dockId": {
"nullable": true,
"type": "string"
},
"friendlyName": {
"nullable": true,
"type": "string"
},
"isPickupStore": {
"type": "boolean"
},
"storeId": {
"nullable": true,
"type": "string"
}
},
"required": [
"isPickupStore",
"storeId",
"friendlyName",
"address",
"additionalInfo",
"dockId"
],
"title": "PickupStoreInfo",
"type": "object"
},
"PickupStoreInfo1": {
"example": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false,
"storeId": null
},
"properties": {
"additionalInfo": {
"nullable": true,
"type": "string"
},
"address": {
"nullable": true,
"type": "string"
},
"dockId": {
"nullable": true,
"type": "string"
},
"friendlyName": {
"nullable": true,
"type": "string"
},
"isPickupStore": {
"type": "boolean"
},
"storeId": {
"nullable": true,
"type": "string"
}
},
"required": [
"isPickupStore",
"storeId",
"friendlyName",
"address",
"additionalInfo",
"dockId"
],
"title": "PickupStoreInfo1",
"type": "object"
},
"SlaRequest": {
"example": {
"deliveryWindows": null,
"dockId": "1_1_1",
"dockTime": "00:00:00",
"freightTableId": "11cc4b6",
"freightTableName": "Correios PAC",
"item": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"listPrice": 10.5,
"location": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"pickupStoreInfo": null,
"promotionalPrice": 10.5,
"slaType": "Normal",
"slaTypeName": "Normal",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"transitTime": "2.00:00:00",
"wareHouseId": "1937054",
"wmsEndPoint": ""
},
"properties": {
"deliveryWindows": {
"nullable": true,
"type": "string"
},
"dockId": {
"type": "string"
},
"dockTime": {
"type": "string"
},
"freightTableId": {
"type": "string"
},
"freightTableName": {
"type": "string"
},
"item": {
"example": {
"additionalHandlingTime": "00:00:00",
"dimension": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"groupItemId": null,
"id": "2390059",
"kitItem": [],
"modal": null,
"price": 0,
"quantity": 1,
"unlimitedQuantity": false
},
"properties": {
"additionalHandlingTime": {
"type": "string"
},
"dimension": {
"example": {
"height": 10,
"length": 35,
"maxSumDimension": 0,
"weight": 800,
"width": 12
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "Dimension1",
"type": "object"
},
"groupItemId": {
"nullable": true,
"type": "string"
},
"id": {
"type": "string"
},
"kitItem": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"modal": {
"nullable": true,
"type": "string"
},
"price": {
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unlimitedQuantity": {
"type": "boolean"
}
},
"required": [
"id",
"groupItemId",
"quantity",
"price",
"modal",
"additionalHandlingTime",
"dimension",
"kitItem",
"unlimitedQuantity"
],
"title": "Item1",
"type": "object"
},
"listPrice": {
"type": "number"
},
"location": {
"example": {
"country": "BRA",
"deliveryPointId": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"point": null,
"zipCode": "22220070"
},
"properties": {
"country": {
"type": "string"
},
"deliveryPointId": {
"nullable": true,
"type": "string"
},
"inStore": {
"example": {
"IsCheckedIn": false,
"StoreId": "180082"
},
"properties": {
"IsCheckedIn": {
"type": "boolean"
},
"StoreId": {
"type": "string"
}
},
"required": [
"IsCheckedIn",
"StoreId"
],
"title": "InStore1",
"type": "object"
},
"point": {
"nullable": true,
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"zipCode",
"country",
"deliveryPointId",
"point",
"inStore"
],
"title": "Location1",
"type": "object"
},
"pickupStoreInfo": {
"nullable": true,
"type": "string"
},
"promotionalPrice": {
"type": "number"
},
"slaType": {
"type": "string"
},
"slaTypeName": {
"type": "string"
},
"timeToDockPlusDockTime": {
"type": "string"
},
"totalTime": {
"type": "string"
},
"transitTime": {
"type": "string"
},
"wareHouseId": {
"type": "string"
},
"wmsEndPoint": {
"type": "string"
}
},
"required": [
"item",
"slaType",
"slaTypeName",
"freightTableName",
"freightTableId",
"listPrice",
"promotionalPrice",
"transitTime",
"dockTime",
"timeToDockPlusDockTime",
"totalTime",
"deliveryWindows",
"wareHouseId",
"dockId",
"wmsEndPoint",
"location",
"pickupStoreInfo"
],
"title": "SlaRequest",
"type": "object"
},
"Success": {
"example": {
"availableQuantity": 2147483634,
"dispatchedReservationsQuantity": 0,
"isUnlimitedQuantity": true,
"quantity": 2147483647,
"skuId": "19",
"totalReservedQuantity": 13,
"warehouseId": "1_1"
},
"properties": {
"availableQuantity": {
"format": "int32",
"type": "integer"
},
"dispatchedReservationsQuantity": {
"format": "int32",
"type": "integer"
},
"isUnlimitedQuantity": {
"type": "boolean"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"skuId": {
"type": "string"
},
"totalReservedQuantity": {
"format": "int32",
"type": "integer"
},
"warehouseId": {
"type": "string"
}
},
"required": [
"skuId",
"warehouseId",
"quantity",
"isUnlimitedQuantity",
"totalReservedQuantity",
"dispatchedReservationsQuantity",
"availableQuantity"
],
"title": "Success",
"type": "object"
},
"UpdateInventoryBySkuandWarehouseRequest": {
"example": {
"dateUtcOnBalanceSystem": null,
"quantity": 101,
"unlimitedQuantity": false
},
"properties": {
"dateUtcOnBalanceSystem": {
"nullable": true,
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unlimitedQuantity": {
"type": "boolean"
}
},
"required": [
"unlimitedQuantity",
"dateUtcOnBalanceSystem",
"quantity"
],
"title": "UpdateInventoryBySkuandWarehouseRequest",
"type": "object"
},
"WarehouseDock": {
"example": {
"cost": "5.00",
"costToDisplay": "5,00",
"dockId": "1a8bce3",
"name": "Centro de Distribuição Principal",
"time": "3.00:00:00",
"translateDays": "dias"
},
"properties": {
"cost": {
"type": "string"
},
"costToDisplay": {
"type": "string"
},
"dockId": {
"type": "string"
},
"name": {
"type": "string"
},
"time": {
"type": "string"
},
"translateDays": {
"type": "string"
}
},
"required": [
"dockId",
"name",
"time",
"cost",
"translateDays",
"costToDisplay"
],
"title": "WarehouseDock",
"type": "object"
},
"WarehouseDock1": {
"example": {
"cost": 0,
"dockId": "1_1_1",
"time": "1.00:00:00"
},
"properties": {
"cost": {
"type": "number"
},
"dockId": {
"type": "string"
},
"time": {
"type": "string"
}
},
"required": [
"dockId",
"time",
"cost"
],
"title": "WarehouseDock1",
"type": "object"
},
"allcarrier": {
"example": {
"carrierSchedule": [],
"dayOfWeekBlockeds": [],
"dayOfWeekForDelivery": null,
"deliveryOnWeekends": true,
"exclusiveToDeliveryPoints": false,
"factorCubicWeight": 0.0167,
"freightTableProcessStatus": 1,
"freightTableValueError": null,
"freightValue": [],
"id": "11cc4b6",
"isPolygon": false,
"maxDimension": {
"height": 110,
"length": 110,
"maxSumDimension": 200,
"weight": 0,
"width": 110
},
"maxRangeDelivery": 0,
"minimunCubicWeight": 10000,
"modals": [],
"name": "Correios PAC",
"numberOfItemsPerShipment": null,
"onlyItemsWithDefinedModal": false,
"scheduledDelivery": false,
"slaType": "Normal"
},
"properties": {
"carrierSchedule": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dayOfWeekBlockeds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dayOfWeekForDelivery": {
"description": "Select the chosen days for delivery. Values for each day of the week are: 0 = sunday, 1 = monday, 2 = tuesday, 3 = wednesday, 4 = thursday, 5 = friday, 6 = saturday. Make sure to add the available hours for the chosen days, following the example.",
"items": {
"properties": {
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 2,
"type": "integer"
},
"deliveryRanges": {
"description": "Reservation windows for scheduled delivery.",
"items": {
"properties": {
"deliveryCapacity": {
"description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
"items": {
"example": {
"capacityType": "ORDERS_QUANTITY",
"maxValue": 55
},
"properties": {
"capacityType": {
"description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
"example": "ORDERS_QUANTITY",
"type": "string"
},
"maxValue": {
"description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
"example": 0,
"type": "number"
}
},
"required": [
"capacityType",
"maxValue"
],
"type": "object"
},
"type": "array"
},
"endTime": {
"description": "End time for day of the week.",
"example": "12:30:00",
"type": "string"
},
"listPrice": {
"description": "List price for day of the week.",
"example": 0,
"type": "number"
},
"startTime": {
"description": "Start time for day of the week.",
"example": "11:00:00",
"title": "startTime",
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"type": "object"
},
"nullable": true,
"type": "array"
},
"deliveryOnWeekends": {
"type": "boolean"
},
"exclusiveToDeliveryPoints": {
"type": "boolean"
},
"factorCubicWeight": {
"nullable": true,
"type": "number"
},
"freightTableProcessStatus": {
"format": "int32",
"type": "integer"
},
"freightTableValueError": {
"nullable": true,
"type": "string"
},
"freightValue": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"isPolygon": {
"type": "boolean"
},
"maxDimension": {
"example": {
"height": 110,
"length": 110,
"maxSumDimension": 200,
"weight": 0,
"width": 110
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "MaxDimension2",
"type": "object"
},
"maxRangeDelivery": {
"format": "int32",
"type": "integer"
},
"minimunCubicWeight": {
"type": "number"
},
"modals": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"numberOfItemsPerShipment": {
"nullable": true,
"type": "string"
},
"onlyItemsWithDefinedModal": {
"type": "boolean"
},
"scheduledDelivery": {
"type": "boolean"
},
"slaType": {
"type": "string"
}
},
"required": [
"id",
"slaType",
"name",
"scheduledDelivery",
"maxRangeDelivery",
"dayOfWeekForDelivery",
"dayOfWeekBlockeds",
"freightValue",
"factorCubicWeight",
"freightTableProcessStatus",
"freightTableValueError",
"modals",
"onlyItemsWithDefinedModal",
"deliveryOnWeekends",
"carrierSchedule",
"maxDimension",
"exclusiveToDeliveryPoints",
"minimunCubicWeight",
"isPolygon",
"numberOfItemsPerShipment"
],
"title": "allcarrier",
"type": "object"
},
"carrierbyid": {
"example": {
"carrierSchedule": [],
"dayOfWeekBlockeds": [],
"dayOfWeekForDelivery": null,
"deliveryOnWeekends": true,
"exclusiveToDeliveryPoints": false,
"factorCubicWeight": 0.0167,
"freightTableProcessStatus": 1,
"freightTableValueError": null,
"freightValue": [],
"id": "11cc4b6",
"isPolygon": false,
"maxDimension": {
"height": 110,
"length": 110,
"maxSumDimension": 200,
"weight": 0,
"width": 110
},
"maxRangeDelivery": 0,
"minimunCubicWeight": 10000,
"modals": [],
"name": "Correios PAC",
"numberOfItemsPerShipment": null,
"onlyItemsWithDefinedModal": false,
"scheduledDelivery": false,
"slaType": "Normal"
},
"properties": {
"carrierSchedule": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dayOfWeekBlockeds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"dayOfWeekForDelivery": {
"description": "Select the chosen days for delivery. Values for each day of the week are: 0 = sunday, 1 = monday, 2 = tuesday, 3 = wednesday, 4 = thursday, 5 = friday, 6 = saturday. Make sure to add the available hours for the chosen days, following the example.",
"items": {
"properties": {
"dayOfWeek": {
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 2,
"type": "integer"
},
"deliveryRanges": {
"description": "Reservation windows for scheduled delivery.",
"items": {
"properties": {
"deliveryCapacity": {
"description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
"items": {
"example": {
"capacityType": "ORDERS_QUANTITY",
"maxValue": 55
},
"properties": {
"capacityType": {
"description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
"example": "ORDERS_QUANTITY",
"type": "string"
},
"maxValue": {
"description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
"example": 0,
"type": "number"
}
},
"required": [
"capacityType",
"maxValue"
],
"type": "object"
},
"type": "array"
},
"endTime": {
"description": "End time for day of the week.",
"example": "12:30:00",
"type": "string"
},
"listPrice": {
"description": "List price for day of the week.",
"example": 0,
"type": "number"
},
"startTime": {
"description": "Start time for day of the week.",
"example": "11:00:00",
"title": "startTime",
"type": "string"
}
},
"required": [
"startTime",
"endTime",
"listPrice"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dayOfWeek",
"deliveryRanges"
],
"type": "object"
},
"nullable": true,
"type": "array"
},
"deliveryOnWeekends": {
"type": "boolean"
},
"exclusiveToDeliveryPoints": {
"type": "boolean"
},
"factorCubicWeight": {
"type": "number"
},
"freightTableProcessStatus": {
"format": "int32",
"type": "integer"
},
"freightTableValueError": {
"nullable": true,
"type": "string"
},
"freightValue": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"isPolygon": {
"type": "boolean"
},
"maxDimension": {
"example": {
"height": 110,
"length": 110,
"maxSumDimension": 200,
"weight": 0,
"width": 110
},
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"maxSumDimension": {
"type": "number"
},
"weight": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"title": "MaxDimension2",
"type": "object"
},
"maxRangeDelivery": {
"format": "int32",
"type": "integer"
},
"minimunCubicWeight": {
"type": "number"
},
"modals": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"numberOfItemsPerShipment": {
"nullable": true,
"type": "string"
},
"onlyItemsWithDefinedModal": {
"type": "boolean"
},
"scheduledDelivery": {
"type": "boolean"
},
"slaType": {
"type": "string"
}
},
"required": [
"id",
"slaType",
"name",
"scheduledDelivery",
"maxRangeDelivery",
"dayOfWeekForDelivery",
"dayOfWeekBlockeds",
"freightValue",
"factorCubicWeight",
"freightTableProcessStatus",
"freightTableValueError",
"modals",
"onlyItemsWithDefinedModal",
"deliveryOnWeekends",
"carrierSchedule",
"maxDimension",
"exclusiveToDeliveryPoints",
"minimunCubicWeight",
"isPolygon",
"numberOfItemsPerShipment"
],
"title": "carrierbyid",
"type": "object"
}
},
"securitySchemes": {
"appKey": {
"in": "header",
"name": "X-VTEX-API-AppKey",
"type": "apiKey"
},
"appToken": {
"in": "header",
"name": "X-VTEX-API-AppToken",
"type": "apiKey"
}
}
}
}