{ "openapi": "3.0.0", "info": { "title": "Operational Capacity API", "description": "This API allows management of sellers' fulfillment locations and their capacities for VTEX logistics operations. It supports retrieving capacities by parent account, configuring capacity settings per location, listing capacity details, retrieving a paginated list of locations, and updating location status.", "version": "1.0" }, "servers": [ { "url": "https://{accountName}.{environment}.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" }, "environment": { "description": "Environment to use. Used as part of the URL.", "enum": [ "vtexcommercestable" ], "default": "vtexcommercestable" } } } ], "paths": { "/api/fulfillment-locations/capacity/by-parent-account-name": { "get": { "tags": [ "Capacity" ], "summary": "Get locations capacities by account", "description": "Retrieves the current capacities of all locations associated with a parent account.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Content-Type" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationCapacity" } }, "example": [ { "locationId": "locationId_3", "accountName": "seller_2", "accountId": "id_2", "availability": { "amountUsagePercentage": 0, "startAt": "2025-02-10T00:00:00-03:00", "endAt": "2025-02-10T23:59:59-03:00" } } ] } } } } } }, "/api/fulfillment-locations/location/{locationId}/capacities/{code}": { "put": { "tags": [ "Capacity configuration" ], "summary": "Configure location capacity", "description": "Updates the capacity settings of a specific location for a given task type (`code`). The API allows configuration of capacity parameters (such as capacity type, unit, and actions) that control the operational capacity of the location. If a field is omitted, the current values will be preserved.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/locationIdPath" }, { "name": "code", "in": "path", "description": "The type of task to update. Currently, the only supported value is `fulfill_orders`.", "required": true, "schema": { "type": "string", "default": "fulfill_orders" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityConfigurationRequest" }, "example": { "capacityType": "FIXED", "capacityUnit": "ORDERS", "fullCapacityAction": "PAUSE", "maxIncreasePromise": { "amount": 18 }, "dayCapacity": { "MONDAY": 11, "TUESDAY": 3, "WEDNESDAY": 1, "THURSDAY": 8, "FRIDAY": 4, "SATURDAY": 10, "SUNDAY": 7, "HOLIDAYS_AND_EXCEPTIONS": 5 } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityConfigurationResponse" }, "example": { "id": 71, "capacityType": "FIXED", "capacityUnit": "ORDERS", "fullCapacityAction": "PAUSE", "taskId": 1, "locationTask": null, "capacityShifts": [ { "id": 607, "capacityAmount": 11, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "MONDAY" }, { "id": 608, "capacityAmount": 3, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "TUESDAY" }, { "id": 609, "capacityAmount": 5, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "WEDNESDAY" }, { "id": 610, "capacityAmount": 6, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "THURSDAY" }, { "id": 611, "capacityAmount": 9, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "FRIDAY" }, { "id": 612, "capacityAmount": 10, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "SATURDAY" }, { "id": 613, "capacityAmount": 7, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "SUNDAY" }, { "id": 614, "capacityAmount": 5, "capacityRuleId": 71, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "HOLIDAYS_AND_EXCEPTIONS" } ], "additionalInfo": { "maxIncreasePromise": { "amount": 18, "unit": "DAYS" } } } } } } } } }, "/api/fulfillment-locations/locations/{locationId}/capacities": { "get": { "tags": [ "Capacity details" ], "summary": "List location capacities", "description": "Lists the capacity details for the next `daysRequested` days for the specified location. If `daysRequested` is not provided, it defaults to `3` days.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/locationIdPath" }, { "name": "daysRequested", "in": "query", "description": "Number of days to be displayed. Defaults to `3` if not provided.", "required": false, "style": "form", "schema": { "type": "integer", "default": 3 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of capacity details for the specified location.", "items": { "$ref": "#/components/schemas/CapacityDetail" } }, "example": [ { "amountPercentage": 92.10526315789474, "capacityLimitAmount": 38, "capacityUsageAmount": 35, "startAt": "2025-02-07T03:00:00+00:00", "endAt": "2025-02-08T02:59:59+00:00" }, { "amountPercentage": 93.42105263157895, "capacityLimitAmount": 39, "capacityUsageAmount": 36, "startAt": "2025-02-08T03:00:00+00:00", "endAt": "2025-02-09T02:59:59+00:00" }, { "amountPercentage": 74.34210526315789, "capacityLimitAmount": 40, "capacityUsageAmount": 30, "startAt": "2025-02-09T03:00:00+00:00", "endAt": "2025-02-10T02:59:59+00:00" } ] } } } } } }, "/api/fulfillment-locations/location": { "get": { "tags": [ "Locations" ], "summary": "List locations", "description": "Retrieves a paginated list of fulfillment locations that match the given search criteria and status filter. Pagination is controlled via `page` and `pageSize` parameters.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Content-Type" }, { "name": "page", "in": "query", "description": "Page number, starting from `0`. Defaults to `0` if not provided.", "required": false, "style": "form", "schema": { "type": "integer", "default": 0 } }, { "name": "pageSize", "in": "query", "description": "Number of results per page (maximum: `30`). Defaults to `30` if not provided.", "required": false, "style": "form", "schema": { "type": "integer", "default": 30, "maximum": 30 } }, { "name": "status", "in": "query", "description": "Filter by location status. Multiple statuses can be separated by commas.", "required": false, "style": "form", "schema": { "type": "string", "enum": [ "ACTIVE", "MANUALLY_PAUSED", "PAUSED" ], "example": "ACTIVE" } }, { "name": "search", "in": "query", "description": "Search for locations by name.", "required": false, "style": "form", "schema": { "type": "string", "example": "seller_2" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationsList" }, "example": { "hasNextPage": false, "data": [ { "id": "ef1523fc-1e4f-4e1c-ab0b-9f863b7bdbeb", "name": "logisticstestqa", "status": "ACTIVE", "timeZone": "America/Fortaleza", "vtexAccountName": "logisticstestqa", "segmentationType": "SALES_CHANNEL", "vtexAccount": { "id": "15fd1d07-e88f-48f8-9f40-68e7940d2338", "name": "logisticstestqa", "companyName": "Companhia Brasileira de Tecnologia para e-commerce", "ownerAccountName": "logisticstestqa" }, "locationTasks": [ { "id": 7538, "locationId": "ef1523fc-1e4f-4e1c-ab0b-9f863b7bdbeb", "segmentationGroupId": null, "location": null, "capacityRule": { "id": 41496, "capacityType": "UNLIMITED", "capacityUnit": "ORDERS", "fullCapacityAction": "MOVE_TO_NEXT_SHIFT", "taskId": 7538, "locationTask": null, "capacityShifts": [], "additionalInfo": { "maxIncreasePromise": { "amount": 1, "unit": "DAYS" } } }, "locationCapacity": { "locationId": "ef1523fc-1e4f-4e1c-ab0b-9f863b7bdbeb", "taskId": 7538, "currentShift": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "firstShiftAhead": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "secondShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "thirdShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null } } }, { "id": 32104, "locationId": "ef1523fc-1e4f-4e1c-ab0b-9f863b7bdbeb", "segmentationGroupId": "26008211-ed34-4931-8b61-0cf71b252aa5", "location": null, "capacityRule": { "id": 51290, "capacityType": "UNLIMITED", "capacityUnit": "ORDERS", "fullCapacityAction": "PAUSE", "taskId": 32104, "locationTask": null, "capacityShifts": [], "additionalInfo": { "maxIncreasePromise": { "amount": 1, "unit": "DAYS" } } }, "locationCapacity": { "locationId": "ef1523fc-1e4f-4e1c-ab0b-9f863b7bdbeb", "taskId": 32104, "currentShift": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "firstShiftAhead": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "secondShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "thirdShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null } } }, { "id": 32105, "locationId": "ef1523fc-1e4f-4e1c-ab0b-9f863b7bdbeb", "segmentationGroupId": "5344d169-6a9d-4c40-9b89-ea5e538c066e", "location": null, "capacityRule": { "id": 51291, "capacityType": "UNLIMITED", "capacityUnit": "ORDERS", "fullCapacityAction": "PAUSE", "taskId": 32105, "locationTask": null, "capacityShifts": [], "additionalInfo": { "maxIncreasePromise": { "amount": 0, "unit": "DAYS" } } }, "locationCapacity": { "locationId": "ef1523fc-1e4f-4e1c-ab0b-9f863b7bdbeb", "taskId": 32105, "currentShift": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "firstShiftAhead": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "secondShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "thirdShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null } } } ], "segmentationGroups": [], "address": { "id": 0, "locationId": null, "formattedAddress": null, "route": null, "streetNumber": null, "premise": null, "subPremise": null, "locality": null, "subLocalityLevel1": null, "subLocalityLevel2": null, "subLocalityLevel3": null, "country": null, "administrativeAreaLevel1": null, "administrativeAreaLevel2": null, "administrativeAreaLevel3": null, "postalCode": null, "geoLocationLatitude": 0, "geoLocationLongitude": 0, "geoLocation": { "latitude": 0, "longitude": 0 } }, "isSegmented": true }, { "id": "44f314fe-0bf4-40dc-8181-22d11c959254", "name": "Seller cypress test", "status": "ACTIVE", "timeZone": "America/Sao_Paulo", "vtexAccountName": "logisticstestqacf001", "segmentationType": null, "vtexAccount": { "id": "810e79d9-265a-4393-97c7-ceb3f8681f25", "name": "logisticstestqacf001", "companyName": "Companhia Brasileira de Tecnologia para e-commerce", "ownerAccountName": "logisticstestqa" }, "locationTasks": [ { "id": 7540, "locationId": "44f314fe-0bf4-40dc-8181-22d11c959254", "segmentationGroupId": null, "location": null, "capacityRule": { "id": 20720, "capacityType": "FIXED", "capacityUnit": "ORDERS", "fullCapacityAction": "MOVE_TO_NEXT_SHIFT", "taskId": 7540, "locationTask": null, "capacityShifts": [], "additionalInfo": { "maxIncreasePromise": { "amount": 12, "unit": "DAYS" } } }, "locationCapacity": { "locationId": "44f314fe-0bf4-40dc-8181-22d11c959254", "taskId": 7540, "currentShift": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "firstShiftAhead": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "secondShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "thirdShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null } } } ], "segmentationGroups": [], "address": { "id": 0, "locationId": null, "formattedAddress": null, "route": null, "streetNumber": null, "premise": null, "subPremise": null, "locality": null, "subLocalityLevel1": null, "subLocalityLevel2": null, "subLocalityLevel3": null, "country": null, "administrativeAreaLevel1": null, "administrativeAreaLevel2": null, "administrativeAreaLevel3": null, "postalCode": null, "geoLocationLatitude": 0, "geoLocationLongitude": 0, "geoLocation": { "latitude": 0, "longitude": 0 } }, "isSegmented": false } ] } } } } } } }, "/api/fulfillment-locations/locations/{locationId}/status": { "put": { "tags": [ "Location status" ], "summary": "Update location status", "description": "Updates the status of a specific location (identified by `locationId`) to either `ACTIVE` or `MANUALLY_PAUSED`.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/locationIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocationStatusRequest" }, "example": { "status": "MANUALLY_PAUSED" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" }, "example": { "id": "locationId_1", "name": "Location A", "status": "ACTIVE", "timeZone": "America/Sao_Paulo", "vtexAccountName": "logisticstestqacf001", "segmentationType": null, "vtexAccount": { "id": "810e79d9-265a-4393-97c7-ceb3f8681f25", "name": "logisticstestqacf001", "companyName": "Companhia Brasileira de Tecnologia para e-commerce", "ownerAccountName": "logisticstestqa" }, "locationTasks": [ { "id": 7540, "locationId": "locationId_1", "segmentationGroupId": null, "location": null, "capacityRule": { "id": 20720, "capacityType": "FIXED", "capacityUnit": "ORDERS", "fullCapacityAction": "MOVE_TO_NEXT_SHIFT", "taskId": 7540, "locationTask": null, "capacityShifts": [ { "id": 79730, "capacityAmount": 10000, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "MONDAY" }, { "id": 79731, "capacityAmount": 10000, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "TUESDAY" }, { "id": 79732, "capacityAmount": 10000, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "WEDNESDAY" }, { "id": 79733, "capacityAmount": 10000, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "THURSDAY" }, { "id": 79734, "capacityAmount": 10000, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "FRIDAY" }, { "id": 79735, "capacityAmount": 10000, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "SATURDAY" }, { "id": 79736, "capacityAmount": 10000, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "SUNDAY" }, { "id": 79737, "capacityAmount": 0, "capacityRuleId": 20720, "timeStart": "00:00:00", "timeEnd": "23:59:59", "weekDay": "HOLIDAYS_AND_EXCEPTIONS" } ], "additionalInfo": { "maxIncreasePromise": { "amount": 12, "unit": "DAYS" } } }, "locationCapacity": { "locationId": "locationId_1", "taskId": 7540, "currentShift": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "firstShiftAhead": { "amountPercentage": 0, "capacityLimitAmount": 0, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "secondShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null }, "thirdShiftAhead": { "amountPercentage": null, "capacityLimitAmount": null, "capacityUsageAmount": null, "startAt": null, "endAt": null } } } ], "segmentationGroups": [], "address": { "id": 0, "locationId": "locationId_1", "formattedAddress": "Praia de Botafogo, 300 - Botafogo, Rio de Janeiro - RJ, 22250-040, Brazil", "route": "Praia de Botafogo", "streetNumber": "300", "premise": null, "subPremise": null, "locality": null, "subLocalityLevel1": "Botafogo", "subLocalityLevel2": null, "subLocalityLevel3": null, "country": "Brazil", "administrativeAreaLevel1": "Rio de Janeiro", "administrativeAreaLevel2": "Rio de Janeiro", "administrativeAreaLevel3": null, "postalCode": "22250-040", "geoLocationLatitude": -22.9443311, "geoLocationLongitude": -43.1825559, "geoLocation": { "latitude": -22.9443311, "longitude": -43.1825559 } }, "isSegmented": false } } } } } } } }, "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "components": { "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", "description": "Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)." }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken", "description": "Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)." }, "VtexIdclientAutCookie": { "type": "apiKey", "in": "header", "name": "VtexIdclientAutCookie", "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." } }, "parameters": { "locationIdPath": { "name": "locationId", "in": "path", "description": "Unique identifier of the location.", "required": true, "schema": { "type": "string", "example": "71" } }, "Content-Type": { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "Accept": { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } }, "schemas": { "LocationCapacity": { "type": "object", "description": "Object that represents the capacity information for a fulfillment location, including its identifier, account details, and availability window.", "properties": { "locationId": { "type": "string", "description": "Unique identifier for the location." }, "accountName": { "type": "string", "description": "Name of the account associated with the location." }, "accountId": { "type": "string", "description": "Identifier for the VTEX account." }, "availability": { "type": "object", "description": "Availability details including usage percentage and time window.", "properties": { "amountUsagePercentage": { "type": "number", "description": "Percentage of capacity currently in use." }, "startAt": { "type": "string", "format": "date-time", "description": "Start time of the availability period." }, "endAt": { "type": "string", "format": "date-time", "description": "End time of the availability period." } } }, "firstShiftAhead": { "description": "First shift ahead.", "type": "object", "properties": { "amountPercentage": { "type": "number", "description": "Percentage of capacity used." }, "capacityLimitAmount": { "type": "integer", "description": "Maximum capacity amount for the day." }, "capacityUsageAmount": { "type": "integer", "description": "Capacity amount used for the day." }, "startAt": { "type": "string", "format": "date-time", "description": "Start time for the capacity period." }, "endAt": { "type": "string", "format": "date-time", "description": "End time for the capacity period." } } }, "secondShiftAhead": { "description": "Second shift ahead.", "type": "object", "properties": { "amountPercentage": { "type": "number", "description": "Percentage of capacity used." }, "capacityLimitAmount": { "type": "integer", "description": "Maximum capacity amount for the day." }, "capacityUsageAmount": { "type": "integer", "description": "Capacity amount used for the day." }, "startAt": { "type": "string", "format": "date-time", "description": "Start time for the capacity period." }, "endAt": { "type": "string", "format": "date-time", "description": "End time for the capacity period." } } }, "thirdShiftAhead": { "description": "Third shift ahead.", "type": "object", "properties": { "amountPercentage": { "type": "number", "description": "Percentage of capacity used." }, "capacityLimitAmount": { "type": "integer", "description": "Maximum capacity amount for the day." }, "capacityUsageAmount": { "type": "integer", "description": "Capacity amount used for the day." }, "startAt": { "type": "string", "format": "date-time", "description": "Start time for the capacity period." }, "endAt": { "type": "string", "format": "date-time", "description": "End time for the capacity period." } } } } }, "CapacityConfigurationRequest": { "type": "object", "description": "Configuration settings for a location's operational capacity including type, unit, full capacity action, maximum allowed increase promise, and daily capacity settings.", "properties": { "capacityType": { "type": "string", "enum": [ "FIXED", "UNLIMITED" ], "description": "Type of capacity." }, "capacityUnit": { "type": "string", "enum": [ "ORDERS", "ORDER_ITEMS" ], "description": "Unit of capacity." }, "fullCapacityAction": { "type": "string", "enum": [ "PAUSE", "MOVE_TO_NEXT_SHIFT" ], "description": "Action to take when full capacity is reached." }, "maxIncreasePromise": { "type": "object", "description": "Defines the maximum allowed increase in the delivery promise.", "properties": { "amount": { "type": "integer", "maximum": 18, "description": "Maximum number of additional capacity units allowed." } } }, "dayCapacity": { "type": "object", "description": "Capacity settings for each day of the week and exceptions.", "properties": { "MONDAY": { "type": "integer", "description": "Capacity setting for Monday." }, "TUESDAY": { "type": "integer", "description": "Capacity setting for Tuesday." }, "WEDNESDAY": { "type": "integer", "description": "Capacity setting for Wednesday." }, "THURSDAY": { "type": "integer", "description": "Capacity setting for Thursday." }, "FRIDAY": { "type": "integer", "description": "Capacity setting for Friday." }, "SATURDAY": { "type": "integer", "description": "Capacity setting for Saturday." }, "SUNDAY": { "type": "integer", "description": "Capacity setting for Sunday." }, "HOLIDAYS_AND_EXCEPTIONS": { "type": "integer", "description": "Capacity setting for holidays and exceptions." } } } } }, "CapacityConfigurationResponse": { "type": "object", "properties": { "id": { "description": "Unique identifier of the capacity rule.", "type": "integer" }, "capacityType": { "type": "string", "enum": [ "FIXED", "UNLIMITED" ], "description": "Type of capacity." }, "capacityUnit": { "type": "string", "enum": [ "ORDERS", "ORDER_ITEMS" ], "description": "Unit of capacity." }, "fullCapacityAction": { "type": "string", "enum": [ "PAUSE", "MOVE_TO_NEXT_SHIFT" ], "description": "Action to take when full capacity is reached." }, "taskId": { "description": "Unique identifier of the task.", "type": "integer" }, "locationTask": { "description": "Object containing information of the task associated with the location.", "type": "object", "nullable": true }, "capacityShifts": { "description": "List of capacity shifts of the location.", "type": "array", "items": { "description": "Object cointaing capacity shift information.", "type": "object", "properties": { "id": { "description": "Unique identifier of the capacity shift.", "type": "integer" }, "capacityAmount": { "description": "Amount of product avaiable in the capacity shift.", "type": "integer" }, "capacityRuleId": { "description": "Unique identifier of the capacity rule. This is the same ID value in `id` field.", "type": "integer" }, "timeStart": { "description": "Start time for the capacity period in the format `HH:MM:SS`.", "type": "string" }, "timeEnd": { "description": "time for the capacity period in the format `HH:MM:SS`.", "type": "string" }, "weekDay": { "description": "Day of the week.", "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY", "HOLIDAYS_AND_EXCEPTIONS" ] } } } }, "additionalInfo": { "description": "Additional information of the capacity shifts.", "type": "object", "properties": { "maxIncreasePromise": { "type": "object", "description": "Defines the maximum allowed increase in the delivery promise.", "properties": { "amount": { "type": "integer", "maximum": 18, "description": "Maximum number of additional capacity units allowed." }, "unit": { "type": "string", "description": "Unit of the amount.", "enum": [ "DAYS", "WEEKS" ] } } } } } } }, "CapacityDetail": { "type": "object", "description": "Details for a specific day's capacity including usage percentage, limit, usage amount, and the active time window.", "properties": { "amountPercentage": { "type": "number", "description": "Percentage of capacity used." }, "capacityLimitAmount": { "type": "integer", "description": "Maximum capacity amount for the day." }, "capacityUsageAmount": { "type": "integer", "description": "Capacity amount used for the day." }, "startAt": { "type": "string", "format": "date-time", "description": "Start time for the capacity period." }, "endAt": { "type": "string", "format": "date-time", "description": "End time for the capacity period." } } }, "Location": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the location." }, "name": { "type": "string", "description": "Name of the location." }, "status": { "type": "string", "enum": [ "ACTIVE", "MANUALLY_PAUSED", "PAUSED" ], "description": "Current status of the location." }, "timeZone": { "type": "string", "description": "Time zone of the location." }, "vtexAccountName": { "type": "string", "description": "VTEX account name associated with the location." }, "vtexAccount": { "type": "object", "description": "Detailed VTEX account information.", "properties": { "id": { "type": "string", "description": "VTEX account unique identifier." }, "name": { "type": "string", "description": "Name of the VTEX account." }, "companyName": { "type": "string", "description": "Company name associated with the VTEX account." }, "ownerAccountName": { "type": "string", "description": "Owner account name." } } }, "locationTasks": { "type": "array", "description": "List of tasks associated with the location.", "items": { "type": "object", "description": "Represents a task associated with the location." } }, "address": { "type": "object", "description": "Address details of the location.", "properties": { "formattedAddress": { "type": "string", "description": "The full formatted address." }, "country": { "type": "string", "description": "Country where the location is situated." }, "administrativeAreaLevel1": { "type": "string", "description": "First administrative division (e.g., state)." }, "administrativeAreaLevel2": { "type": "string", "description": "Second administrative division (e.g., city)." }, "postalCode": { "type": "string", "description": "Postal code of the location." }, "geoLocation": { "type": "object", "description": "Geographic coordinates of the location.", "properties": { "latitude": { "type": "number", "description": "Latitude coordinate." }, "longitude": { "type": "number", "description": "Longitude coordinate." } } } } } } }, "LocationsList": { "type": "object", "properties": { "hasNextPage": { "type": "boolean", "description": "Indicates if there is another page of results." }, "data": { "type": "array", "description": "List of fulfillment locations.", "items": { "type": "object", "description": "Represents a fulfillment location with its details, including identifier, name, status, time zone, account information, associated tasks, and address.", "properties": { "id": { "type": "string", "description": "Unique identifier of the location." }, "name": { "type": "string", "description": "Name of the location." }, "status": { "type": "string", "enum": [ "ACTIVE", "MANUALLY_PAUSED", "PAUSED" ], "description": "Current status of the location." }, "timeZone": { "type": "string", "description": "Time zone of the location." }, "vtexAccountName": { "type": "string", "description": "VTEX account name associated with the location." }, "segmentationType": { "description": "Type of segmentation.", "type": "string", "nullable": true, "enum": [ "SALES_CHANNEL", null ] }, "vtexAccount": { "description": "Detailed VTEX account information.", "type": "object", "properties": { "id": { "description": "VTEX account unique identifier.", "type": "string" }, "name": { "description": "Name of the VTEX account.", "type": "string" }, "companyName": { "description": "Company name associated with the VTEX account.", "type": "string" }, "ownerAccountName": { "description": "Owner account name.", "type": "string" } } }, "locationTasks": { "description": "List of tasks associated with the location.", "type": "array", "items": { "description": "Represents a task associated with the location.", "type": "object", "properties": { "id": { "description": "Unique identifier of the task.", "type": "integer" }, "locationId": { "description": "Unique identifier of the location.", "type": "string" }, "segmentationGroupId": { "description": "Unique identifier of the segmentation group.", "type": "string" }, "location": { "description": "Location details.", "$ref": "#/components/schemas/Location" }, "capacityRule": { "description": "Capacity rule details.", "$ref": "#/components/schemas/CapacityConfigurationResponse" }, "locationCapacity": { "description": "Location capacity details.", "$ref": "#/components/schemas/LocationCapacity" } } } }, "segmentationGroups": { "description": "List of segmentation groups.", "type": "array", "items": { "description": "Represents a segmentation group.", "type": "object", "properties": { "id": { "description": "Unique identifier of the segmentation group.", "type": "string" }, "name": { "description": "Name of the segmentation group.", "type": "string" } } } }, "address": { "description": "Address details of the location.", "type": "object", "properties": { "id": { "description": "Unique identifier of the address.", "type": "integer" }, "locationId": { "description": "Unique identifier of the location.", "type": "string", "nullable": true }, "formattedAddress": { "description": "The full formatted address.", "type": "string", "nullable": true }, "route": { "description": "Address route.", "type": "string", "nullable": true }, "streetNumber": { "description": "Street number.", "type": "string", "nullable": true }, "premise": { "description": "Address premise.", "type": "string", "nullable": true }, "subPremise": { "description": "Sub-premise.", "type": "string", "nullable": true }, "locality": { "description": "Address locality.", "type": "string", "nullable": true }, "subLocalityLevel1": { "description": "Sub-locality level 1.", "type": "string", "nullable": true }, "subLocalityLevel2": { "description": "Sub-locality level 2.", "type": "string", "nullable": true }, "subLocalityLevel3": { "description": "Sub-locality level 3.", "type": "string", "nullable": true }, "country": { "description": "Country where the address is situated.", "type": "string", "nullable": true }, "administrativeAreaLevel1": { "description": "First administrative division (e.g., state).", "type": "string", "nullable": true }, "administrativeAreaLevel2": { "description": "Second administrative division (e.g., city).", "type": "string", "nullable": true }, "administrativeAreaLevel3": { "description": "Third administrative division.", "type": "string", "nullable": true }, "postalCode": { "description": "Postal code of the address.", "type": "string", "nullable": true }, "geoLocationLatitude": { "description": "Geographic latitude coordinate.", "type": "number" }, "geoLocationLongitude": { "description": "Geographic longitude coordinate.", "type": "number" }, "geoLocation": { "description": "Geographic coordinates of the location.", "type": "object", "properties": { "latitude": { "description": "Geographic latitude coordinate.", "type": "number" }, "longitude": { "description": "Geographic longitude coordinate.", "type": "number" } } } } }, "isSegmented": { "description": "Indicates if the location is segmented (`true`) or not (`false`).", "type": "boolean" } } } } } }, "UpdateLocationStatusRequest": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "MANUALLY_PAUSED" ], "description": "New status of the location." } }, "required": [ "status" ] } } }, "tags": [ { "name": "Capacity" }, { "name": "Capacity configuration" }, { "name": "Capacity details" }, { "name": "Locations" }, { "name": "Location status" } ] }