Production URL: https://gacela.co
\nDevelopment/Testing URL: https://gacela.dev
\nTo keep your communication with our servers secure, starting January 1st, 2022, 07:00:00 GMT-5 we will drop support for TLS 1.0 and 1.1, in response to security concerns around these protocols. Before using this API, please make sure that your systems support TLS 1.2.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11653309","collectionId":"10c6c9ec-514d-49c1-81bb-1f3aa7c2c1a4","publishedId":"2s9YsM8Vkk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-10T15:39:15.000Z"},"item":[{"name":"Orders","item":[{"name":"Store coverage","id":"a058832b-e2e1-4a22-9b4d-e1bede6a44e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Checks if a point (delivery location) is within the coverage of a store.
\nRequest Body Parameters
\nResponse Parameters
\nThis endpoint returns an order’s delivery fee based on the store’s location and
the delivery location. This resource does not create a new order.
NOTE: This endpoint will return an error if the delivery location is outside our coverage, or if the store's area is experiencing high demand. Example error responses are available in the Example Request section to the right. Please refer to the Demand Alerts section of this documentation for reference.
\nRequest Body Parameters
\nResponse Parameters
\nThis endpoint allows developers to create orders for a specific store.
Order dispatching is handled automatically by Gacela Delivery once an order is created successfully.
Request Body Parameters
\nResponse Parameters
\nThis endpoint cancels an order. Once cancelled, an order will not be handled (dispatched or delivered) by Gacela Delivery. An order cannot be cancelled if the current status of the order is any of the following:
\nStructure
\nIn Gacela Delivery, every partner is identified by a Company. Every company has a unique API token that grants access to our API. Companies can have multiple pickup locations, which we call Stores. Every store has a unique token.
\nDelivery requests are called Orders. Once we receive an order, our algorithms will identify the appropriate delivery person to pick up and deliver the order. Every order has a starting point (a Store) and a destination (the delivery address and location).
\nOrder Status
\nAn order goes through several states, from its creation to its delivery. Each state is recorded in our system and produces events that our partners can obtain in real-time (webhooks) or on demand (tracking API). The table below shows all the possible statuses of an order.
\n","_postman_id":"062c6e60-559e-40f7-b1df-21a711c828bc"},{"name":"Tracking","item":[{"name":"Order tracking using order token","id":"d2ccec03-1629-4f25-97f3-d76daec53851","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/order_tracking/Track an order using Gacela Delivery’s order_token. Check the order creation endpoint documentation for reference on how to obtain this token.
\nTrack an order using the order’s external_id. In order to use this method, you should have created the order using the external_id field. Check the order creation endpoint documentation for reference.
\nYou may use the following endpoints to track an order using its identifiers (order token or external ID).
Note: these endpoints have a limit of 200 requests per minute.
This endpoint returns a store's demand status. Gacela Delivery handles two types of demand alerts: alerta (medium demand) and bloqueo (high demand). Medium and high demand alerts are notified via webhook (configured per store) to a configured endpoint.
\nRequest Body Parameters
\nResponse Parameters
\nUsing the demand alert's token, users may acknowledge receiving a demand alert notification by sending a POST request to this endpoint. Every demand alert has a unique alert token.
\nRequest Body Parameters
\n","urlObject":{"path":["api","demand_stats","notifications","This section refers to Gacela Delivery's demand analysis. We handle two types of demand alerts.
\nDevelopers may request the current demand for a specific store. Gacela Delivery also notifies its clients when a demand alert is generated by sending a POST request to a configured webhook endpoint (demand alert webhooks are configured per store).
\n- Medium demand (alerta): we are experiencing increased demand in the store's area. Delivery times may be affected.
\n- High demand (bloqueo): due to increased demand, we cannot handle any new delivery requests at this time. Order creation requests will be blocked for a while.
\nTypes of demand alerts:
\n","_postman_id":"d1678c7f-189c-42f2-9ad6-8d44f7df9b03"},{"name":"Stores","item":[{"name":"Get stores info","id":"1dd0dc86-f50a-4aaa-9f37-6cebc8f14977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Fetch data on all your stores registered in our system.
\nYou may send a store creation request to add additional stores for your company. Store creation requests have three possible states: Pending, Approved, or Rejected.
\nYou may also configure a Store Creation Request webhook to receive realtime updates whenever a store creation request changes its state. Approved requests include the store's API token in the payload, so you can synchronize and activate your stores easily.
\nUse this endpoint to modify an existing store request using the store's external_id and login email. You may update a Rejected request to change its state to Pending.
\nYou may delete a store creation request using this endpoint. Only Pending and Rejected requests can be deleted.
\n","urlObject":{"path":["api","requests","store_creation","Use this endpoint to fetch all your store requests. Approved requests include the store's API token. Rejected requests include a reason for rejection. You may submit a PUT request using the same external ID and email to modify the existing request.
\n","urlObject":{"path":["api","requests","store_creation","statuses"],"query":[],"variable":[]}},"response":[{"id":"28f6966a-ba57-4958-be66-70bbfe3c0ab6","name":"Get Store Requests","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerConfigure this webhook in order to receive realtime updates whenever an order changes its state.
\nUsing the order's order_token and external_id, Gacela Delivery notifies its clients when an order changes its state by sending a POST request to a configured webhook endpoint. Webhook URLs are configured per store.
\nA POST request is sent when the following events take place:
\nA driver accepts the order and is on its way to the store (ASSIGNED)
\nThe driver has arrived at the store (AT_PICKUP)
\nThe driver is on its way to deliver the package (DELIVERING)
\nThe driver has arrived at the drop off location (AT_DROPOFF)
\nThe driver delivered the package (DELIVERED)
\nThe driver could not deliver the package (NOT_DELIVERED)
\nSearching for a new driver (SEARCHING)
\nThe order is deleted (DELETED)
\nWe expect all webhook endpoints to return a 200 (HTTP OK) status-code, no additional information is required.
We retry webhook POST requests every five minutes for up to two hours whenever we receive a failed status-code (4xx, 5xx). The payload of the webhook retries will always contain up-to-date order tracking information. Webhook retries stop when we receive a successful response (2xx).
Request Body Parameters
\n","urlObject":{"host":["Configure this webhook to receive updates whenever an order changes its state.
\nIn Gacela Delivery, an order's delivery process is governed by several order states.
\n","_postman_id":"50f8617f-0329-4aeb-bae1-a9d0a26c2b23"},{"name":"Demand Alerts","item":[{"name":"Demand alerts webhook","id":"7fdf6278-3599-4808-a9a7-9dcc03f8aada","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"We will send a POST request to a configured webhook endpoint whenever a demand alert is generated for a store. The body of the request includes the store's API token and the demand alert info.
\nA POST request is sent when the demand in the store's area has changed from:
\n