{"info":{"_postman_id":"b37131fc-437c-4a12-9263-bf0c572d4d1b","name":"Yelo | Custom DMS Integration","description":"

Overview

\n

This documentation provides detailed steps for integrating your custom delivery Delivery Managerment System (DMS) with Yelo. By following these steps, you can smoothly send orders from your Yelo platform to your chosen DMS.

\n

Prerequisites

\n\n
\n

Configuring Custom DMS URL on Yelo dashboard

\n
    \n
  1. From your Yelo dashboard go to \"Integration\".
    2. \n
  2. Click on \"Configure DMS\".
    3. \n
  3. In the \"Custom DMS Integration\" section, you'll find a list with details like DMS Name, URL, Auth Token, Status, and Action.
    4. \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription
DMS NameCustom DMS name. (eg : Dunzo)
EmailIf there's an error while sending a webhook, information will be sent to the provided email.
URLUser defined endpoint to which order creation payload will be sent from Yelo.
Auth TokenUse to validate the received payloads. Will be sent in the X-Yelo-Token HTTP header.
\n

Note : All fields are mandatory when adding DMS integration.

\n

Note : You can only integrate one DMS at a time; it's not possible to integrate multiple DMS simultaneously.

\n

Reference Material :

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Prerequisites","slug":"prerequisites"}],"owner":"15678241","collectionId":"b37131fc-437c-4a12-9263-bf0c572d4d1b","publishedId":"2s9YeG5AxC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-28T12:41:06.000Z"},"item":[{"name":"Create Order","id":"91a87c1b-8485-4b2a-96e8-04ca2630a580","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https:///","description":"

Order creation payload will be pushed to this endpoint.

\n

We require an endpoint from the integrator to which Yelo will push the order details after it is created on yelo platform.

\n

Request Payload :

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyDescription
job_idUnique Job ID on Yelo
job_descriptionJob Description if any
checkout_templateCustom template set by the user.
Sample :
[ { \"label\": \"Sample\", \"value\": \"\", \"data_type\": \"Image\", \"display_name\": \"Sample\" } ]
job_delivery_datetimeExpected Job Delivery Time
*In Local Time
creation_datetimeJob Creation Time
*In UTC
marketplace_user_idYelo Admin User ID
taxTax Amount If Any
delivery_chargeDelivery Charges If Any
total_amountTotal Order Amount (After tax,discount,delivery charges etc)
order_amountOrder Amount inclusive of only the product prices
payment_type“Cash”
timezoneTimeZone** set by admin on the Yelo admin dashboard.
merchant_emailMerchant Email ID
merchant_phone_numberMerchant Phone Number
merchant_nameMerchant Name
merchant_idMerchant User ID on Yelo Platform
merchant_addressMerchant Address
merchant_latitudeMerchant’s Latitude
merchant_longitudeMerchant’s Longitude
tipTip Amount if any
customer_idCustomer ID on Yelo Platform
customer_usernameCustomer Name
job_latitudeOrder Delivery Latitude
job_longitudeOrder Delivery Longitude
job_statusCurrent Order Status
10 : Order Created
12 : Dispatched
13 : Delivered
15 : Canceled
promo_codePromo Code If Any
order_preparation_timeOrder Preparation Time
*In Minutes
currency_codeCurrency Code
*ISO 4217
currency_symbolCurrency Symbol
delivery_charge_surge_amountSurge Amount on Delivery If Any
customer_phoneCustomer Phone Number
job_addressCustomer Address
customer_emailCustomer Email
address_objAdditional Customer Address Details If Any
{ \"landmark\": \"-\",
\"house\": \"-\",
\"postal_code\": \"-\"
}
\n

**TimeZone - Calculated in minutes from UTC (eg : Indian Standard Time (IST) is 5 hours and 30 minutes ahead of UTC, therefore timezone = 0 - (5*60 + 30) = -330. Similarly Pacific Standard Time (PST) is 7 hours behind UTC, therefore timezone = 0 - (-7*60) = 420.)

\n","urlObject":{"protocol":"https","path":[""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"91a87c1b-8485-4b2a-96e8-04ca2630a580"},{"name":"Webhook","id":"f7829afd-77b2-4c2e-abc7-30b55d65b54a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"api_key\" : {{api_key}},\n\"order_id\" : {{order_id}},\n\"status\" : {{status}},\n\"tracking_link\" : {{tracking_link}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/delivery-integration/callback","description":"

Use this webhook to update the order status or tracking link on yelo.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
api_keyString (Required)Yelo API Key
order_idString (Required)Unique Yelo Job ID
statusNumber (Required)Order Status :
12 : Dispatched
13 : Delivered
15 : Canceled
tracking_linkString (Optional)Tacking Link
\n
","urlObject":{"protocol":"https","path":["delivery-integration","callback"],"host":["api","yelo","red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7829afd-77b2-4c2e-abc7-30b55d65b54a"}],"event":[{"listen":"prerequest","script":{"id":"6cf79de8-8425-48a1-8a6a-3ae52d7da5fa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1dc7699d-72cf-4c81-9bff-81b96baeedba","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}