vtex.local – Logistics-API

Tools (55)

Extracted live via the executor SDK.

• docks.activateDock

  Activates dock through dock ID.

• docks.allDocks

  Informs a list of all docks.

• docks.createUpdateDock

  Creates or updates docks to be used in your logistic operation.

• docks.deactivateDock

  Deactivate dock by dock ID

• docks.dock

  Deletes dock by dock ID.

• docks.dockById

  Informs a given dock's information, searching by dock ID.

• freightValues.createUpdateFreightValues

  Creates or updates the freight values of your store's carriers. Learn more in Shipping rate template.

• freightValues.getLogisticsPvtConfigurationFreightsValues

  Lists freight values apointed to your store's carriers, searching by carrier ID and postal code (cep).

• holidays.allHolidays

  Lists information of all holidays.

• holidays.createUpdateHoliday

  Creates or updates holidays through holiday ID.

• holidays.holiday

  Deletes given holidays set up in your store.

• holidays.holidayById

  Lists holiday's information by holiday ID.

• inventory.getinventorywithdispatchedreservations

  Lists inventory with dispatched reservations. When the number of active reservations is more than 2000 the return is an error with status code 400 (BadRequest) and the message: Too many active reservations.

• inventory.getSupplyLots

  Returns a list of the supply lots of an SKU in a specific warehouse.

• inventory.inventoryBySku

  Lists your store's inventory by SKU ID

• inventory.inventoryperdock

  Lists inventory information per dock set up in your store.

• inventory.inventoryperdockandwarehouse

  Lists information of inventory per dock and warehouse.

• inventory.inventoryperwarehouse

  Lists inventory information per warehouse on your store.

• inventory.saveSupplyLot

  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 about this feature.

• inventory.transferSupplyLot

  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 about this feature.

• inventory.updateInventoryBySkuandWarehouse

  Updates inventory for a given SKU and warehouse.

• pickupPoints.createUpdatePickupPoint

  Creates or updates pickup points in your store by Pickup Point ID.

• pickupPoints.delete

  Deletes a given pickup point for your store, by pickup point ID.

• pickupPoints.getById

  Lists your store's pickup points while searching by ID.

• pickupPoints.getpaged

  Lists paged pickup points in your store.

• pickupPoints.listAllPickupPpoints

  Lists all of your store's pickup points.

• polygons.createUpdatePolygon

  Creates or updates your store's polygons by geoshape coordinates and polygon name.

• polygons.deletePolygon

  Deletes polygon set up in your store, by polygon name.

• polygons.pagedPolygons

  Lists stored polygons.

• polygons.polygonbyId

  Lists your store's polygons by searching through polygon name

• reservations.acknowledgmentReservation

  Acknowledges reservations made by reservation ID.

• reservations.cancelReservation

  Cancels reservation by reservation ID.

• reservations.confirmReservation

  Confirms reservation by reservation ID.

• reservations.createReservation

  Creates reservation.

• reservations.reservationById

  Lists reservation's information by ID.

• reservations.reservationbyWarehouseandSku

  Lists reservations in your store, by searching through warehouse and SKU.

• scheduledDelivery.addBlockedDeliveryWindows

  Adds blocked delivery windows for your store's shipping policies.

  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.

• scheduledDelivery.getApiLogisticsCapacityResourcesCarrierCapacityTypeShippingPolicyIdTimeFrames

  Get information on all capacity reservations made to scheduled delivery windows in a given time range.

  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.

  Note that the combined string carrier@{capacityType}@{shippingPolicyId} can be referred to as a "resource" in the API's messages.

• scheduledDelivery.getApiLogisticsCapacityResourcesCarrierCapacityTypeShippingPolicyIdTimeFramesWindowDayFWindowStartTimeTWindowEndTime

  Retrieves capacity usage of a specific scheduled delivery reservation window.

  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.

  Note that the combined string carrier@{capacityType}@{shippingPolicyId} can be referred to as a "resource" in the API's messages.

• scheduledDelivery.removeBlockedDeliveryWindows

  Removes the blocked delivery windows set to your store's shipping policies.

  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.

• scheduledDelivery.retrieveBlockedDeliveryWindows

  Lists all blocked delivery windows of your store's shipping policies, searching by carrier ID.

  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.

• shippingPolicies.deleteApiLogisticsPvtShippingPoliciesId

  This endpoint deletes existing shipping policies from carriers in your store, searching by their IDs.

• shippingPolicies.getApiLogisticsPvtShippingPolicies

  This endpoint lists existing shipping policies from carriers in your store.

  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.

• shippingPolicies.getApiLogisticsPvtShippingPoliciesId

  This endpoint lists existing shipping policies from carriers in your store, searching by their IDs.

  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.

• shippingPolicies.postApiLogisticsPvtShippingPolicies

  This endpoint creates new shipping policies from carriers in your store.

  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.

• shippingPolicies.putApiLogisticsPvtShippingPoliciesId

  This endpoint updates information on existing Shipping Policies from carriers.

  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.

• sla.calculateSla

  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.

  The calculation of the estimated date considers the shipping policy and loading dock related to the order.

• warehouses.activateWarehouse

  Activates a given warehouse, by warehouse ID.

• warehouses.allWarehouses

  Lists information about all warehouses set up in your store.

• warehouses.createUpdateWarehouse

  Creates or updates your store's warehouses

• warehouses.deactivateWarehouse

  Deactivates a given warehouse by warehouse ID.

• warehouses.removeWarehouse

  Deletes given warehouse by warehouse ID.

• warehouses.warehouseById

  Lists the information of a given warehouse, searching by warehouse ID.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools