Edit Boundary

Delete Boundary

The "Delete Boundary" API endpoint requires a unique integer boundaryId to delete a specific boundary, responds with a 200 status on success or 400 on bad request, and includes example cURL request headers such as tenantId, x-api-key, and x-compression.

Check Delivery Assurance

The Delivery Assurance service offers five key checks—Store Boundary, DSP, Store Boundary + DSP, Confidence Score, and Return Confidence Score—to verify delivery coverage and reliability based on store boundaries, provider availability, and confidence metrics, with specific requirements such as providing pickup and dropoff times for time-window checks, restrictions on provider configurations, caching options to reduce latency, and current availability of confidence scores only in the U.S., while excluding business rules and orchestration engine usage.

Delivery Solutions API Doc - Premium

The Delivery Solutions API documentation provides sandbox and production base URLs and portals, instructions for importing and running a Postman collection including a pre-script request, and specifies that authentication requires passing a generated API key and tenantId in request headers while keeping the key secure.

Get Order by External ID

The "Get Order by External ID" API allows retrieval of an order using a unique external ID, optionally forcing an update to fetch the latest order details from the provider (if supported), returning the order data with possible error information, and uses HTTP status codes 200, 400, or 404 to indicate success or failure.

Create Order

The "Create Order" API request requires parameters such as order type (delivery, in-store pickup, curbside, or shipping), a required unique storeExternalId and orderExternalId, orderValue, deliveryContact, and deliveryAddress (except for pickup types), with optional fields like groupId, tips, pickupTime, dropoffTime, and package details to facilitate accurate delivery estimates and provider selection.

Create Batch

The "Create Batch" API endpoint requires a unique batchExternalId, dispatch details specifying scheduling and reference times, sorting parameters to prioritize order dispatch by fields like deliveryDistance, and optionally order details, with example usage shown via a POST request including headers and JSON body, returning status codes such as 201 for success or 400 for errors.