openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 240 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://vtex.local"},{"description":"VTEX server URL.","url":"https://{accountName}.{environment}.com.br","variables":{"accountName":{"default":"{accountName}","description":"Name of the VTEX account. Used as part of the URL."},"environment":{"default":"{environment}","description":"Environment to use. Used as part of the URL."}}}],"info":{"contact":{},"description":"\r\n\r\n>Check the [Fulfillment onboarding guide](https://developers.vtex.com/docs/guides/fulfillment). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about fulfillment and is organized by focusing on the developer's journey.\r\n\r\nLogistics or fulfillment is the module responsible for shipping calculation and inventory management. \r\n\r\nThe variable `{{environment}}` can be filled with `vtexcommercestable` or `vtexcommercebeta`, depending on the environment you want to test.","title":"Logistics API","version":"1.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Logistics API.json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Logistics-API"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"Scheduled Delivery"},{"name":"Shipping Policies"},{"name":"Docks"},{"name":"Warehouses"},{"name":"Inventory"},{"name":"Holidays"},{"name":"Reservations"},{"name":"SLA"},{"name":"Pickup Points"},{"name":"Polygons"},{"name":"Freight Values"}],"paths":{"/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames":{"get":{"deprecated":false,"description":"Get information on all capacity reservations made to scheduled delivery windows in a given time range.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a \"resource\" in the API's messages.","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"example":"application/vnd.vtex.availability.v1+json","type":"string"},"style":"simple"},{"description":"How the delivery capacity is measured as defined in the shipping policy. Capacity can be measured by maximum number of orders (`\"orders_quantity\"`) or SKUs (`\"skus_quantity\"`).","in":"path","name":"capacityType","required":true,"schema":{"example":"{{capacityType}}","type":"string"},"style":"simple"},{"description":"ID of shipping policy to search.","in":"path","name":"shippingPolicyId","required":true,"schema":{"example":"{{shippingPolicyId}}","type":"string"},"style":"simple"},{"description":"Starting date of time range","in":"query","name":"rangeStart","required":true,"schema":{"example":"yyyy-mm-dd","type":"string"},"style":"form"},{"description":"End date of time range.","in":"query","name":"rangeEnd","required":true,"schema":{"example":"yyyy-mm-dd","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"endDate":"2025-04-15T13:51:55.948Z","id":"2021-05-03F1300T1700","log":[{"what":"Unblocked","when":"2025-04-15T13:51:55.948Z","who":"","why":"Reservation `reservation-01` with 2.0 units."},{"what":"Unblocked","when":"2025-04-15T13:51:55.948Z","who":"","why":"Reservation `reserva-02` with 4.0 units."}],"ownMaxCapacity":10,"reservations":[{"id":"reservation-01","value":4},{"id":"reserva-02","value":2}],"reservedValue":6,"resourceId":"carrier@skus_quantity@143e313","resourceMaxCapacity":10,"startDate":"2025-04-15T13:51:55.948Z"}}},"description":"OK"}},"summary":"Search capacity reservations in time range","tags":["Scheduled Delivery"]}},"/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}":{"get":{"deprecated":false,"description":"Retrieves capacity usage of a specific scheduled delivery reservation window.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a \"resource\" in the API's messages.","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"example":"application/vnd.vtex.availability.v1+json","type":"string"},"style":"simple"},{"description":"How the delivery capacity is measured as defined in the shipping policy. Capacity can be measured by maximum number of orders (`\"orders_quantity\"`) or SKUs (`\"skus_quantity\"`).","in":"path","name":"capacityType","required":true,"schema":{"example":"{{capacityType}}","type":"string"},"style":"simple"},{"description":"ID of shipping policy to search.","in":"path","name":"shippingPolicyId","required":true,"schema":{"example":"{{shippingPolicyId}}","type":"string"},"style":"simple"},{"description":"Day of the specific scheduled delivery window to be consulted for reservations.","in":"path","name":"windowDay","required":true,"schema":{"example":"yyyy-mm-dd","type":"string"},"style":"simple"},{"description":"Start time of specific scheduled delivery window to be consulted for reservations.","in":"path","name":"windowStartTime","required":true,"schema":{"example":"hhmm","type":"string"},"style":"simple"},{"description":"End time of specific scheduled delivery window to be consulted for reservations.","in":"path","name":"windowEndTime","required":true,"schema":{"example":"hhmm","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"endDate":"2025-04-15T13:51:55.948Z","id":"2021-05-03F1300T1700","log":[{"what":"Unblocked","when":"2025-04-15T13:51:55.948Z","who":"","why":"Reservation `reservation-01` with 4 units."}],"ownMaxCapacity":10,"reservations":[{"id":"reservation-01","value":4}],"reservedValue":4,"resourceId":"carrier@skus_quantity@143e313","resourceMaxCapacity":10,"startDate":"2025-04-15T13:51:55.948Z"}}},"description":"OK"}},"summary":"Get capacity reservation usage by window","tags":["Scheduled Delivery"]}},"/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked":{"post":{"deprecated":false,"description":"Adds blocked delivery windows for your store's shipping policies.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.","operationId":"AddBlockedDeliveryWindows","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"carrierId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json; charset=utf-8":{"example":"\"2016-08-09T08:00:00\"","schema":{"example":"\"2016-08-09T08:00:00\"","type":"string"}}},"description":"","required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"Add blocked delivery windows","tags":["Scheduled Delivery"]}},"/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked":{"get":{"deprecated":false,"description":"Lists all blocked delivery windows of your store's shipping policies, searching by carrier ID.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.","operationId":"RetrieveBlockedDeliveryWindows","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"carrierId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK"}},"summary":"Retrieve blocked delivery windows","tags":["Scheduled Delivery"]}},"/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked":{"post":{"deprecated":false,"description":"Removes the blocked delivery windows set to your store's shipping policies.\n\r\n\r> Note that, while most of our API endpoints return time fields in UTC, this endpoint returns time adjusted to the configured time zone of the account.","operationId":"RemoveBlockedDeliveryWindows","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"carrierId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json; charset=utf-8":{"example":"\"2016-08-09T08:00:00\"","schema":{"example":"\"2016-08-09T08:00:00\"","type":"string"}}},"description":"","required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"Remove blocked delivery windows","tags":["Scheduled Delivery"]}},"/api/logistics/pvt/configuration/docks":{"get":{"deprecated":false,"description":"Informs a list of all docks.","operationId":"AllDocks","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":[{"dockTimeFake":"1.00:00:00","freightTableIds":["11cc4b6","teste1","186a2a6","1962962","173a63f"],"id":"1a8bce3","name":"Centro de Distribuição Principal","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1","2"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},{"dockTimeFake":"00:00:00","freightTableIds":["1962962","teste1","11cc4b6"],"id":111,"name":"Doca A","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":1,"salesChannel":null,"salesChannels":["1","11","4","2","12","13","14","7","16"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},{"dockTimeFake":"1.00:00:00","freightTableIds":[],"id":"139270d","name":"Doca B","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1"],"timeFakeOverhead":"1.00:00:00","wmsEndPoint":""},{"dockTimeFake":"00:00:00","freightTableIds":[],"id":"18dd839","name":"Doca C","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1"],"timeFakeOverhead":"00:00:00","wmsEndPoint":"http://recurrent-env-beta.elasticbeanstalk.com/recorrenciawms"},{"dockTimeFake":"1.00:00:00","freightTableIds":[],"id":"avl","name":"Doca InStore","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["18"],"timeFakeOverhead":"1.00:00:00","wmsEndPoint":""},{"dockTimeFake":"1.00:00:00","freightTableIds":[],"id":"pickup_1","name":"Pickup Point 1","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},{"dockTimeFake":"1.00:00:00","freightTableIds":[],"id":"pickup_2","name":"Pickup Point 2","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},{"dockTimeFake":"1.00:00:00","freightTableIds":[],"id":"pickup_3","name":"Pickup Point 3","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""}],"schema":{"items":{"example":{"dockTimeFake":"1.00:00:00","freightTableIds":["11cc4b6","teste1","186a2a6","1962962","173a63f"],"id":"1a8bce3","name":"Centro de Distribui├º├úo Principal","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1","2"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},"properties":{"dockTimeFake":{"type":"string"},"freightTableIds":{"description":"","items":{"type":"string"},"type":"array"},"id":{"type":"string"},"name":{"type":"string"},"pickupStoreInfo":{"example":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"properties":{"additionalInfo":{"nullable":true,"type":"string"},"address":{"nullable":true,"type":"string"},"dockId":{"nullable":true,"type":"string"},"friendlyName":{"nullable":true,"type":"string"},"isPickupStore":{"type":"boolean"},"storeId":{"nullable":true,"type":"string"}},"required":["isPickupStore","storeId","friendlyName","address","additionalInfo","dockId"],"title":"PickupStoreInfo1","type":"object"},"priority":{"format":"int32","type":"integer"},"salesChannel":{"nullable":true,"type":"string"},"salesChannels":{"description":"","items":{"type":"string"},"type":"array"},"timeFakeOverhead":{"type":"string"},"wmsEndPoint":{"type":"string"}},"required":["id","name","priority","dockTimeFake","timeFakeOverhead","salesChannels","salesChannel","freightTableIds","wmsEndPoint","pickupStoreInfo"],"type":"object"},"type":"array"}}},"description":"OK","headers":{"Cache-Control":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Encoding":{"content":{"text/plain":{"example":"gzip","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"469","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Fri, 15 Apr 2016 19:58:37 GMT","schema":{"type":"string"}}}},"Expires":{"content":{"text/plain":{"example":"-1","schema":{"type":"string"}}}},"Pragma":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"Vary":{"content":{"text/plain":{"example":"Accept-Encoding","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-CacheServer":{"content":{"text/plain":{"example":"janus-apicache-nginx5","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-ApiCache":{"content":{"text/plain":{"example":"v1.3.8","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.26.4","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Router":{"content":{"text/plain":{"example":"2.1.155","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"stable","schema":{"type":"string"}}}},"X-VTEX-Cache-Status-Janus-ApiCache":{"content":{"text/plain":{"example":"MISS","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"logist-v6.2.96-stable+863","schema":{"type":"string"}}}},"x-vtex-operation-id":{"content":{"text/plain":{"example":"4dc9fc80-722a-468f-8f7d-aabe2b804b18","schema":{"type":"string"}}}}}}},"summary":"List all docks","tags":["Docks"]},"post":{"deprecated":false,"description":"Creates or updates docks to be used in your logistic operation.","operationId":"Create/UpdateDock","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json; charset=utf-8":{"example":{"address":{"city":"Rio de Janeiro","complement":"","coordinates":[[-43.18228090000002,-22.9460398]],"country":{"acronym":"BRA","name":"Brazil"},"neighborhood":"Catete","number":"100","postalCode":"22220070","state":"RJ","street":"Artur Bernardes Street"},"dockTimeFake":"00:00:00","freightTableIds":[],"id":"catete","name":"Loja Catete","priority":0,"salesChannel":null,"salesChannels":["1"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},"schema":{"example":{"address":{"city":"Rio de Janeiro","complement":"","coordinates":[[-43.18228090000002,-22.9460398]],"country":{"acronym":"BRA","name":"Brazil"},"neighborhood":"Catete","number":"100","postalCode":"22220070","state":"RJ","street":"Artur Bernardes Street"},"dockTimeFake":"00:00:00","freightTableIds":[],"id":"catete","name":"Loja Catete","priority":0,"salesChannel":null,"salesChannels":["1"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},"properties":{"address":{"example":{"city":"Rio de Janeiro","complement":"","coordinates":[[-43.18228090000002,-22.9460398]],"country":{"acronym":"BRA","name":"Brazil"},"neighborhood":"Catete","number":"100","postalCode":"22220070","state":"RJ","street":"Artur Bernardes Street"},"properties":{"city":{"type":"string"},"complement":{"type":"string"},"coordinates":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},"country":{"example":{"acronym":"BRA","name":"Brazil"},"properties":{"acronym":{"type":"string"},"name":{"type":"string"}},"required":["acronym","name"],"title":"Country","type":"object"},"neighborhood":{"type":"string"},"number":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"required":["postalCode","country","city","state","neighborhood","street","number","complement","coordinates"],"title":"Address1","type":"object"},"dockTimeFake":{"type":"string"},"freightTableIds":{"description":"","items":{"type":"string"},"type":"array"},"id":{"type":"string"},"name":{"type":"string"},"priority":{"format":"int32","type":"integer"},"salesChannel":{"nullable":true,"type":"string"},"salesChannels":{"description":"","items":{"type":"string"},"type":"array"},"timeFakeOverhead":{"type":"string"},"wmsEndPoint":{"type":"string"}},"required":["id","name","priority","dockTimeFake","timeFakeOverhead","salesChannels","salesChannel","freightTableIds","wmsEndPoint","address"],"title":"Create/UpdateDockRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"Create/update dock","tags":["Docks"]}},"/api/logistics/pvt/configuration/docks/{dockId}":{"delete":{"deprecated":false,"description":"Deletes dock by dock ID.","operationId":"Dock","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"dockId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"Delete dock","tags":["Docks"]},"get":{"deprecated":false,"description":"Informs a given dock's information, searching by dock ID.","operationId":"DockById","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"dockId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"dockTimeFake":"1.00:00:00","freightTableIds":["11cc4b6","teste1","186a2a6","1962962","173a63f"],"id":"1a8bce3","name":"Centro de Distribui├º├úo Principal","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1","2"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},"schema":{"example":{"dockTimeFake":"1.00:00:00","freightTableIds":["11cc4b6","teste1","186a2a6","1962962","173a63f"],"id":"1a8bce3","name":"Centro de Distribui├º├úo Principal","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"priority":0,"salesChannel":null,"salesChannels":["1","2"],"timeFakeOverhead":"00:00:00","wmsEndPoint":""},"properties":{"dockTimeFake":{"type":"string"},"freightTableIds":{"description":"","items":{"type":"string"},"type":"array"},"id":{"type":"string"},"name":{"type":"string"},"pickupStoreInfo":{"example":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false,"storeId":null},"properties":{"additionalInfo":{"nullable":true,"type":"string"},"address":{"nullable":true,"type":"string"},"dockId":{"nullable":true,"type":"string"},"friendlyName":{"nullable":true,"type":"string"},"isPickupStore":{"type":"boolean"},"storeId":{"nullable":true,"type":"string"}},"required":["isPickupStore","storeId","friendlyName","address","additionalInfo","dockId"],"title":"PickupStoreInfo1","type":"object"},"priority":{"format":"int32","type":"integer"},"salesChannel":{"nullable":true,"type":"string"},"salesChannels":{"description":"","items":{"type":"string"},"type":"array"},"timeFakeOverhead":{"type":"string"},"wmsEndPoint":{"type":"string"}},"required":["id","name","priority","dockTimeFake","timeFakeOverhead","salesChannels","salesChannel","freightTableIds","wmsEndPoint","pickupStoreInfo"],"title":"","type":"object"}}},"description":"OK","headers":{"Cache-Control":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"391","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Fri, 15 Apr 2016 19:58:51 GMT","schema":{"type":"string"}}}},"Expires":{"content":{"text/plain":{"example":"-1","schema":{"type":"string"}}}},"Pragma":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-CacheServer":{"content":{"text/plain":{"example":"janus-apicache-nginx2","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-ApiCache":{"content":{"text/plain":{"example":"v1.3.8","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.26.4","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Router":{"content":{"text/plain":{"example":"2.1.155","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"stable","schema":{"type":"string"}}}},"X-VTEX-Cache-Status-Janus-ApiCache":{"content":{"text/plain":{"example":"MISS","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"logist-v6.2.96-stable+863","schema":{"type":"string"}}}},"x-vtex-operation-id":{"content":{"text/plain":{"example":"7df9de37-d013-4823-bbd7-5726aa8d7f7a","schema":{"type":"string"}}}}}}},"summary":"List dock by ID","tags":["Docks"]}},"/api/logistics/pvt/configuration/docks/{dockId}/activation":{"post":{"deprecated":false,"description":"Activates dock through dock ID.","operationId":"ActivateDock","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"dockId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"Activate dock","tags":["Docks"]}},"/api/logistics/pvt/configuration/docks/{dockId}/deactivation":{"post":{"deprecated":false,"description":"Deactivate dock by dock ID","operationId":"DeactivateDock","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"dockId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"Deactivate dock","tags":["Docks"]}},"/api/logistics/pvt/configuration/freights/{carrierId}/values/update":{"post":{"deprecated":false,"description":"Creates or updates the freight values of your store's carriers. Learn more in [Shipping rate template](https://help.vtex.com/en/tutorial/planilha-de-frete--tutorials_127#).","operationId":"Create/UpdateFreightValues","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"carrierId","required":true,"schema":{"example":"carrier123","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"description":"Array of objects, each containing information on a specific freight interval.","items":{"properties":{"absoluteMoneyCost":{"description":"Fixed shipping cost to be charged in a decimal number.","example":"1.00","type":"string"},"country":{"description":"Three letter ISO code for the country where the delivery will take place.","example":"BRA","type":"string"},"maxVolume":{"description":"Maximum volume that can be transported by the carrier in cm³.","example":1000000000,"format":"int32","type":"integer"},"operationType":{"description":"Indicates desired action for the object. Possible values are `1` (Insert), `2` (Update) or `3`(Delete).","example":1,"format":"int32","type":"integer"},"polygon":{"description":"Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature.","example":"polygon2","type":"string"},"pricePercent":{"description":"[Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with 10.","example":10,"format":"int32","type":"integer"},"pricePercentByWeight":{"description":"[Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order.","example":0,"format":"int32","type":"integer"},"timeCost":{"description":"Delivery time frame informed by the carrier, in the format DD.HH:MM:SS.","example":"2.00:00:00","type":"string"},"weightEnd":{"description":"Maximum weight allowed.","example":1000,"format":"int32","type":"integer"},"weightStart":{"description":"Minimum weight allowed","example":1,"format":"int32","type":"integer"},"zipCodeEnd":{"description":"End of postal code interval.","example":"1234500","type":"string"},"zipCodeStart":{"description":"Start of postal code interval.","example":"1000000","type":"string"}},"required":["absoluteMoneyCost","country","maxVolume","operationType","pricePercent","pricePercentByWeight","timeCost","weightEnd","weightStart","zipCodeEnd","zipCodeStart","polygon"],"title":"Create/UpdateFreightValuesRequest","type":"object"},"type":"array"}}},"required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"Create/update freight values","tags":["Freight Values"]}},"/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values":{"get":{"deprecated":false,"description":"Lists freight values apointed to your store's carriers, searching by carrier ID and postal code (`cep`).","operationId":"FreightValues","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Carrier ID","in":"path","name":"carrierId","required":true,"schema":{"example":"carrier-123","type":"string"},"style":"simple"},{"description":"Postal code.","in":"path","name":"cep","required":true,"schema":{"example":"12345000","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":[{"absoluteMoneyCost":1,"country":"BRA","maxVolume":1000000000,"minimumValueInsurance":0,"operationType":0,"polygon":"","pricePercent":0,"pricePercentByWeight":0,"restrictedFreights":[],"timeCost":"2.00:00:00","weightEnd":1000,"weightStart":1,"zipCodeEnd":"99999999","zipCodeStart":"0"},{"absoluteMoneyCost":15,"country":"BRA","maxVolume":1000000000,"minimumValueInsurance":0,"operationType":0,"polygon":"","pricePercent":0,"pricePercentByWeight":0,"restrictedFreights":[],"timeCost":"2.00:00:00","weightEnd":10000,"weightStart":1001.001,"zipCodeEnd":"99999999","zipCodeStart":"0"},{"absoluteMoneyCost":20,"country":"BRA","maxVolume":1000000000,"minimumValueInsurance":0,"operationType":0,"polygon":"","pricePercent":0,"pricePercentByWeight":0,"restrictedFreights":[],"timeCost":"2.00:00:00","weightEnd":100000,"weightStart":10001.001,"zipCodeEnd":"99999999","zipCodeStart":"0"}],"schema":{"items":{"example":{"absoluteMoneyCost":1,"country":"BRA","maxVolume":1000000000,"minimumValueInsurance":0,"operationType":0,"polygon":"","pricePercent":0,"pricePercentByWeight":0,"restrictedFreights":[],"timeCost":"2.00:00:00","weightEnd":1000,"weightStart":1,"zipCodeEnd":"99999999","zipCodeStart":"0"},"properties":{"absoluteMoneyCost":{"type":"number"},"country":{"type":"string"},"maxVolume":{"type":"number"},"minimumValueInsurance":{"type":"number"},"operationType":{"format":"int32","type":"integer"},"polygon":{"type":"string"},"pricePercent":{"type":"number"},"pricePercentByWeight":{"type":"number"},"restrictedFreights":{"description":"","items":{"type":"string"},"type":"array"},"timeCost":{"type":"string"},"weightEnd":{"type":"number"},"weightStart":{"type":"number"},"zipCodeEnd":{"type":"string"},"zipCodeStart":{"type":"string"}},"required":["zipCodeStart","zipCodeEnd","weightStart","weightEnd","absoluteMoneyCost","pricePercent","pricePercentByWeight","maxVolume","timeCost","country","operationType","restrictedFreights","polygon","minimumValueInsurance"],"type":"object"},"type":"array"}}},"description":"OK","headers":{"Cache-Control":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"919","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Fri, 15 Apr 2016 19:49:41 GMT","schema":{"type":"string"}}}},"Expires":{"content":{"text/plain":{"example":"-1","schema":{"type":"string"}}}},"Pragma":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-CacheServer":{"content":{"text/plain":{"example":"janus-apicache-nginx1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-ApiCache":{"content":{"text/plain":{"example":"v1.3.8","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.26.4","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Router":{"content":{"text/plain":{"example":"2.1.155","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"stable","schema":{"type":"string"}}}},"X-VTEX-Cache-Status-Janus-ApiCache":{"content":{"text/plain":{"example":"MISS","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"logist-v6.2.96-stable+863","schema":{"type":"string"}}}},"x-vtex-operation-id":{"content":{"text/plain":{"example":"f0945154-c722-40a6-8c24-3873f8cd16c7","schema":{"type":"string"}}}}}}},"summary":"List freight values","tags":["Freight Values"]}},"/api/logistics/pvt/configuration/geoshape":{"get":{"deprecated":false,"description":"Lists stored polygons.","operationId":"PagedPolygons","parameters":[{"description":"","explode":true,"in":"query","name":"page","required":true,"schema":{"example":"{{page}}","type":"string"},"style":"form"},{"description":"","explode":true,"in":"query","name":"perPage","required":true,"schema":{"example":"{{perPage}}","type":"string"},"style":"form"},{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"List paged polygons","tags":["Polygons"]},"put":{"deprecated":false,"description":"Creates or updates your store's polygons by geoshape coordinates and polygon name.","operationId":"CreateUpdatePolygon","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"properties":{"geoShape":{"properties":{"coordinates":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"}},"required":["coordinates"],"title":"GeoShape","type":"object"},"name":{"type":"string"}},"required":["name","geoShape"],"title":"Create/UpdatePolygonRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"Create/update polygon","tags":["Polygons"]}},"/api/logistics/pvt/configuration/geoshape/{polygonName}":{"delete":{"deprecated":false,"description":"Deletes polygon set up in your store, by polygon name.","operationId":"DeletePolygon","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"polygonName","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"Delete polygon","tags":["Polygons"]},"get":{"deprecated":false,"description":"Lists your store's polygons by searching through polygon name","operationId":"PolygonbyId","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"polygonName","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"List polygon by ID","tags":["Polygons"]}},"/api/logistics/pvt/configuration/holidays":{"get":{"deprecated":false,"description":"Lists information of all holidays.","operationId":"AllHolidays","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"List all holidays","tags":["Holidays"]}},"/api/logistics/pvt/configuration/holidays/{holidayId}":{"delete":{"deprecated":false,"description":"Deletes given holidays set up in your store.","operationId":"Holiday","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"holidayId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"Delete holiday","tags":["Holidays"]},"get":{"deprecated":false,"description":"Lists holiday's information by holiday ID.","operationId":"HolidayById","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"holidayId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"List holiday by ID","tags":["Holidays"]},"put":{"deprecated":false,"description":"Creates or updates holidays through holiday ID.","operationId":"Create/UpdateHoliday","parameters":[{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"","in":"path","name":"holidayId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json; charset=utf-8":{"example":{"name":"Natal","startDate":"2025-04-15T13:51:55.949Z"},"schema":{"example":{"name":"Natal","startDate":"2025-04-15T13:51:55.949Z"},"properties":{"name":{"type":"string"},"startDate":{"type":"string"}},"required":["name","startDate"],"title":"Create/UpdateHolidayRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"Create/update holiday","tags":["Holidays"]}},"/api/logistics/pvt/configuration/pickuppoints":{"get":{"deprecated":false,"description":"Lists all of your store's pickup points.","operationId":"ListAllPickupPpoints","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"schema":{"example":[{"address":{"city":"Rio de Janeiro","complement":"","country":{"acronym":"BRA","name":"Brazil"},"location":{"latitude":-22.92860984802246,"longitude":-22.92860984802246},"neighborhood":"Catete","number":"","postalCode":"22220070","state":"RJ","street":"Rua Artur Bernardes"},"businessHours":[{"closingTime":75600,"dayOfWeek":0,"openingTime":39600}],"description":"Loja Barra da Tijuca","formatted_address":"undefined","id":"12345","instructions":"Loja Barra da Tijuca","isActive":true,"name":"Loja Barra da Tijuca","warehouseId":null}],"items":{"example":{"_sort":[1624907190000],"accountGroupId":"814a304c-6fe9-4160-b81e-4c7799170993","accountOwnerId":"c97ef6c8-491a-439f-927c-f9918644329f","accountOwnerName":"coinshop","address":{"city":"Rio de Janeiro","complement":"","country":{"acronym":"BRA","name":"Brasil"},"location":{"latitude":-22.83468,"longitude":-43.36043},"neighborhood":"Barros Filho","number":"21000","postalCode":"21515-001","reference":"","state":"RJ","street":"Avenida Brasil"},"businessHours":[{"closingTime":86340,"dayOfWeek":1,"openingTime":"00:00:00"},{"closingTime":86340,"dayOfWeek":2,"openingTime":"00:00:00"},{"closingTime":86340,"dayOfWeek":3,"openingTime":"00:00:00"},{"closingTime":86340,"dayOfWeek":4,"openingTime":"00:00:00"},{"closingTime":86340,"dayOfWeek":5,"openingTime":"00:00:00"}],"description":"Pup1 description","distance":1624907186176,"formatted_address":"undefined","id":"777","instructions":"","isActive":true,"isThirdPartyPickup":false,"name":"RetireAqui","originalId":"Id","parentAccountName":"parent account name","pickupHolidays":[],"seller":"coinshop","tagsLabel":[]},"properties":{"accountGroupId":{"description":"Account group ID.","type":"string"},"accountOwnerId":{"description":"Account owner ID.","type":"string"},"accountOwnerName":{"description":"Account owner name.","type":"string"},"address":{"properties":{"city":{"description":"City.","type":"string"},"complement":{"description":"Address complement.","type":"string"},"country":{"example":{"acronym":"BRA","name":"Brazil"},"properties":{"acronym":{"description":"Three letter ISO code.","type":"string"},"name":{"description":"Country name.","type":"string"}},"type":"object"},"location":{"description":"Geolocation properties.","example":{"latitude":-22.974477767944336,"longitude":-43.18672561645508},"properties":{"latitude":{"description":"Latitude.","type":"number"},"longitude":{"description":"Longitude.","type":"number"}},"type":"object"},"neighborhood":{"description":"Neighborhood.","type":"string"},"number":{"description":"Pickup point address number.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"state":{"description":"State.","type":"string"},"street":{"description":"Street name.","type":"string"}},"type":"object"},"businessHours":{"description":"Business hours information for each day of the week.","items":{"example":{"closingTime":72000,"dayOfWeek":1,"openingTime":"08:00:00"},"properties":{"closingTime":{"description":"Closing time in `hh:mm:ss`.","type":"string"},"dayOfWeek":{"description":"Day of the week, from `0` (sunday) to `6` (saturday).","type":"integer"},"openingTime":{"description":"Opening time in `hh:mm:ss`.","type":"string"}},"type":"object"},"type":"array"},"description":{"description":"Pickup point description.","type":"string"},"distance":{"description":"Distance.","type":"number"},"formatted_address":{"description":"Formated address.","type":"string"},"id":{"description":"Pickup point ID.","type":"string"},"instructions":{"description":"Instructions.","type":"string"},"isActive":{"description":"Indicates whether pickup point is active.","type":"boolean"},"isThirdPartyPickup":{"description":"Indicates whether pickup point is third party.","type":"boolean"},"name":{"description":"Pickup point name.","type":"string"},"originalId":{"description":"Original ID.","type":"string"},"parentAccountName":{"description":"Parent account name.","type":"string"},"pickupHolidays":{"description":"Holidays which apply for pickup point.","items":{"description":"Holliday date.","type":"string"},"type":"array"},"seller":{"description":"Seller corresponding to pickup point.","type":"string"},"tagsLabel":{"description":"List of tags.","items":{"description":"Tag","type":"string"},"type":"array"}},"type":"object"},"type":"array"}}},"description":"OK"}},"summary":"List all pickup points","tags":["Pickup points"]}},"/api/logistics/pvt/configuration/pickuppoints/_search":{"get":{"deprecated":false,"description":"Lists paged pickup points in your store.","operationId":"Getpaged","parameters":[{"description":"","explode":true,"in":"query","name":"page","required":true,"schema":{"example":"{{pageNumber}}","type":"string"},"style":"form"},{"description":"","explode":true,"in":"query","name":"pageSize","required":true,"schema":{"example":"{{pageSize}}","type":"string"},"style":"form"},{"description":"","explode":true,"in":"query","name":"keyword","required":true,"schema":{"example":"","type":"string"},"style":"form"},{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"List paged Pickup Points","tags":["Pickup points"]}},"/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}":{"delete":{"deprecated":false,"description":"Deletes a given pickup point for your store, by pickup point ID.","operationId":"Delete","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"pickupPointId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK","headers":{}}},"summary":"Delete Pickup Point","tags":["Pickup points"]},"get":{"deprecated":false,"description":"Lists your store's pickup points while searching by ID.","operationId":"GetById","parameters":[{"description":"Type of the content being sent","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json; charset=utf-8","type":"string"},"st