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