{"info":{"_postman_id":"0046a325-329a-444d-833c-04b382168632","name":"Tradly Platform API - V1","description":"

TradlyPlatform - Empowering entrepreneurs and developers with platform infrastructure as a service.

Platform Economy (circular/sharing/gig/on-demand) has the tremendous power to change the world on how we live.

Overview

Build apps with the power of Tradly API starting from a simple marketplace to powerful next-generation apps for your users. Tradly API comes with extendable
architecture to suit your personalization and customization.

Base URLs

You can access Tradly API via one of the below endpoints,

Production: https://api.tradly.app

Starter Kits

Find different starter kits (Reactjs, React Native, Flutter) in our Github https://github.com/TRADLY-PLATFORM

Authentication

In order to access APIs, you will need a valid API KEY. This key is generated when your sign-up is complete and you can always access this via the Superadmin Panel

Get your production(live) API keys from https://tradly.app/signup

Once signed up, goto SuperAdmin > Settings > API

Tradly offers two different keys: publishable key and secret key

secret key: access to all API endpoints including admin-related endpoints.
Endpoints that can be accessed only by secret key are marked as [ADMIN].
publishable key: access to all endpoints other than admin endpoints.

All requests need API KEY in the request header as Bearer token as shown below,

Authorization: Bearer pk_test_****\\*

Onboarding Types

Type 1: Email & Password (2-Step)
Create a new user with email and password as onboarding types. Followed by a success response an email will be triggered to the requested email with 6 digit verification code which has to be used in verify endpoint to create a user successfully.

we are not supporting Mobile based registrataion for Hosted Web Apps (managed by Tradly). This is available only for companies who are using Tradly Headless API.

Type 2: Mobile & OTP (2-Step)
Create new users with a mobile-only onboarding type. Followed by a success response SMS will be triggered to the requested mobile number with 6 digit verification code which has to be used in verify endpoint to create a user successfully.

Type 3: Mobile & Password (2-Step)
Create a new user with mobile and password as onboarding type. Followed by a success response SMS will be triggered to the requested mobile number with 6 digit verification code which has to be used in verify endpoint to create a user successfully.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Base URLs","slug":"base-urls"},{"content":"Authentication","slug":"authentication"},{"content":"Onboarding Types","slug":"onboarding-types"}],"owner":"15405049","collectionId":"0046a325-329a-444d-833c-04b382168632","publishedId":"TzK2YtMU","public":true,"customColor":{"top-bar":"54595f","right-sidebar":"303030","highlight":"13B58C"},"publishDate":"2021-04-28T17:19:31.000Z"},"item":[{"name":"Users","item":[{"name":"Register (Email & Password)","event":[{"listen":"test","script":{"id":"0b872095-ecae-447f-a20d-75297e2a2245","exec":["// Set the baseURL variable to the hostname of the API","pm.variables.set('baseURL', 'https://api.tradly.app');","","// Set the requestURL variable to the full URL of the request","pm.variables.set('requestURL', `{{baseURL}}/v1/users/register`);","","// Set the request method to POST","pm.variables.set('requestMethod', 'POST');","","// Set the request headers","pm.variables.set('requestHeaders', {"," 'Content-Type': 'application/json'","});","","// Set the request body","pm.variables.set('requestBody', {"," \"user\": {"," \"uuid\" : \"4f045199-18f3-4d47-b8ed-cf4252cb98d0\","," \"first_name\" : \"Charles\","," \"last_name\" : \"Pearson\","," \"email\" : \"your_name@example.com\","," \"password\" : \"123123&&!\","," \"type\" : \"customer\""," }","});","","// Send the request","pm.sendRequest({"," url: '{{requestURL}}',"," method: '{{requestMethod}}',"," headers: '{{requestHeaders}}',"," body: '{{requestBody}}'","}, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Set the user_id variable to the returned id in the response"," pm.environment.set('user_id', res.json().user.id);","});","","// Add a test to check the response status code","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a valid JSON\", function () {"," pm.response.to.be.json;","});",""],"type":"text/javascript"}}],"id":"276620fb-8503-4a90-8410-00f020d58242","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \t\"uuid\" : \"4f045199-18f3-4d47-b8ed-cf4252cb98d0\",\n \t\"first_name\" : \"Charles\",\n \t\"last_name\" : \"Pearson\",\n \t\"email\" : \"your_name@example.com\",\n \t\"password\" : \"123123&&!\",\n \t\"type\" : \"customer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/register","description":"

If you have opted for onboarding type 1, then you will have to use this endpoint to register a user with a given request body.

Request:

{\n    \"user\": {\n        \"uuid\" : \"4f045199-18f3-4d47-b8ed-cf4252cb98d0\",\n        \"first_name\" : \"Charles\",\n        \"last_name\" : \"Pearson\",\n        \"email\" : \"your_name@example.com\",\n        \"password\" : \"123123&&!\",\n        \"type\" : \"customer\"\n    }\n}\n

uuid any UUID or randomly generated characters to uniquely identify a session.
first_name first name of the user. shouldn't be empty.
last_name last name of the user. shouldn't be empty.
email valid email address.
password password. minimum 6 characters in length.
type type of the object being returned.

Response:

{\n  \"status\": \"success\",\n  \"data\": {\n    \"verify_id\": 1\n  }\n}\n

verify_id 2 step verification id

6 digit one-time passcode is sent to the given email address upon successfully receiving the response. Use Verify\n endpoint to verify this registration.

\n","urlObject":{"path":["v1","users","register"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"276620fb-8503-4a90-8410-00f020d58242"},{"name":"Register (Mobile & OTP)","event":[{"listen":"test","script":{"id":"005ff362-b856-4936-af63-ff89bd946f18","exec":[""],"type":"text/javascript"}}],"id":"49aac44d-6170-4bd2-a6bb-7502650eb638","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n \"first_name\": \"Charles\",\n \"last_name\": \"Pearson\",\n \"mobile\": \"7700900493\",\n \"dial_code\": \"44\",\n \"type\": \"customer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/register","description":"

If you have opted for onboarding type 2, then you will have to use this endpoint to register a user with a given request body.

Request:

{\n    \"user\": {\n        \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n        \"first_name\": \"Charles\",\n        \"last_name\": \"Pearson\",\n        \"mobile\": \"7700900493\",\n        \"dial_code\": \"44\",\n        \"type\": \"customer\"\n    }\n}\n

uuid any UUID or randomly generated characters to uniquely identify a session.
first_name first name of the user. shouldn't be empty.
last_name last name of the user. shouldn't be empty.
mobile mobile number of the user.
dial_code country dial code without leading + sign.
type type of the object being returned.

Response:

{\n  \"status\": \"success\",\n  \"data\": {\n    \"verify_id\": 1\n  }\n}\n

verify_id 2 step verification id

6 digit one-time passcode is sent to the given mobile number upon successfully receiving the response. Use Verify endpoint to verify this registration.

\n","urlObject":{"path":["v1","users","register"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"49aac44d-6170-4bd2-a6bb-7502650eb638"},{"name":"Login (Email & Password)","event":[{"listen":"test","script":{"id":"5ab0278e-cf54-4351-a96c-c29cf293f342","exec":["var jsonData = pm.response.json();","pm.collectionVariables.set(\"x_auth_key\", jsonData.data.user.key.auth_key);","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"77e19f72-ccf2-4f9a-b849-7f68796d2a25","exec":[""],"type":"text/javascript"}}],"id":"4eb09281-6185-4e32-bd44-6cfca763f438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \t\"uuid\" : \"cea6e059-adbf-4b19-a9c7-0037886050f1\",\n \t\"email\" : \"your_name@example.com\",\n \t\"password\" : \"123123&&!\",\n \t\"type\" : \"customer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/login","description":"

If you have opted for onboarding type 1, then you will have to use this endpoint to login a user with a given request body.

Request:

{\n    \"user\": {\n        \"uuid\" : \"cea6e059-adbf-4b19-a9c7-0037886050f1\",\n        \"email\" : \"your_name@example.com\",\n        \"password\" : \"123123&&!\",\n        \"type\" : \"customer\"\n    }\n}\n

uuid any UUID or randomly generated characters to uniquely identify a session.
email valid email address.
password password. minimum 6 characters in length.
type type of the object being returned.

Response:

{\n    \"status\": true,\n    \"data\": {\n        \"user\": {\n            \"id\": \"692ee113-310b-4e66-b5b5-33796f9616e3\",\n            \"first_name\": \"Charles\",\n            \"last_name\": \"Pearson\",\n            \"email\": \"your_name@example.com\",\n            \"profile_pic\": \"\",\n            \"email_verified\": true,\n            \"key\": {\n                \"auth_key\": \"<AUTH_KEY>\",\n                \"refresh_key\": \"<REFRESH_KEY>\"\n            }\n        }\n    }\n}\n

id unique id of the user.
first_name first name of the user.
last_name last name of the user.
email email address of the user.
profile_pic profile picture URL of the user.
email_verified states email is verified or not.

keys
auth_key authorization key of the user. expires in 30 minutes.
refresh_key refresh key to refresh the auth token when auth key is expired. refer to refresh token endpoint.

\n","urlObject":{"path":["v1","users","login"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"4eb09281-6185-4e32-bd44-6cfca763f438"},{"name":"Login (Mobile & OTP)","id":"4f633ffd-3adc-4af4-a9e2-298e26968fd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n \"mobile\" : \"7700900493\",\n \t\"dial_code\" : \"44\",\n \t\"type\" : \"customer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/login","description":"

If you have opted for onboarding type 2, then you will have to use this endpoint to login a user with a given request body.

Request:

{\n    \"user\": {\n        \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n        \"mobile\" : \"7700900493\",\n        \"dial_code\" : \"44\",\n        \"type\" : \"customer\"\n    }\n}\n

uuid any UUID or randomly generated characters to uniquely identify a session.
mobile mobile number of the user.
dial_code country dial code without leading + sign.
type type of the object being returned.

Response:

{\n  \"status\": \"success\",\n  \"data\": {\n    \"verify_id\": 1\n  }\n}\n

verify_id 2 step verification id

6 digit one-time passcode is sent to the given mobile number upon successfully receiving the response. Use Verify endpoint to verify this login.

\n","urlObject":{"path":["v1","users","login"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f633ffd-3adc-4af4-a9e2-298e26968fd9"},{"name":"Register (Mobile & Password)","id":"25899a57-065a-4f3c-b703-f0ca4a225ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n \"first_name\": \"Charles\",\n \"last_name\": \"Pearson\",\n \"mobile\": \"7700900493\",\n \"dial_code\": \"44\",\n \"password\": \"123123@@!\",\n \"type\": \"customer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/register","description":"

If you have opted for onboarding type 3, then you will have to use this endpoint to register a user with a given request body.

Request:

{\n    \"user\": {\n        \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n        \"first_name\": \"Charles\",\n        \"last_name\": \"Pearson\",\n        \"mobile\": \"7700900493\",\n        \"dial_code\": \"44\",\n        \"password\": \"123123@@!\",\n        \"type\": \"customer\"\n    }\n}\n

uuid any UUID or randomly generated characters to uniquely identify a session.
first_name first name of the user. shouldn't be empty.
last_name last name of the user. shouldn't be empty.
mobile mobile number of the user.
dial_code country dial code without leading + sign.
password password. minimum 6 characters in length.
type type of the object being returned.

Response:

{\n  \"status\": \"success\",\n  \"data\": {\n    \"verify_id\": 1\n  }\n}\n

verify_id 2 step verification id

6 digit one-time passcode is sent to the given mobile number upon successfully receiving the response. Use Verify endpoint to verify this registration.

\n","urlObject":{"path":["v1","users","register"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"25899a57-065a-4f3c-b703-f0ca4a225ef6"},{"name":"Login (Mobile & Password)","event":[{"listen":"test","script":{"id":"e1b2c436-b570-47fb-a9db-b73eb210a664","exec":["var jsonData = pm.response.json();","pm.collectionVariables.set(\"x_auth_key\", jsonData.data.user.key.auth_key);","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"170b17c1-e903-4faa-9874-2660ea3f306b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n \"mobile\": \"7700900493\",\n \"dial_code\": \"44\",\n \"password\": \"123123@@!\",\n \"type\": \"customer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/login","description":"

If you have opted for onboarding type 3, then you will have to use this endpoint to login a user with a given request body.

Request:

{\n    \"user\": {\n        \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\",\n        \"mobile\": \"7700900493\",\n        \"dial_code\": \"44\",\n        \"password\": \"123123@@!\",\n        \"type\": \"customer\"\n    }\n}\n

Response:

{\n    \"status\": true,\n    \"data\": {\n        \"user\": {\n            \"id\": \"692ee113-310b-4e66-b5b5-33796f9616e3\",\n            \"first_name\": \"Charles\",\n            \"last_name\": \"Pearson\",\n            \"email\": \"your_name@example.com\",\n            \"profile_pic\": \"\",\n            \"email_verified\": true,\n            \"key\": {\n                \"auth_key\": \"<AUTH_KEY>\",\n                \"refresh_key\": \"<REFRESH_KEY>\"\n            }\n        }\n    }\n}\n

keys
auth_key authorization key of the user. expires in 30 minutes.
refresh_key refresh key to refresh the auth token when auth key is expired. refer to refresh token endpoint.

\n","urlObject":{"path":["v1","users","login"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"170b17c1-e903-4faa-9874-2660ea3f306b"},{"name":"Verify","event":[{"listen":"test","script":{"id":"6c7e1d3b-d181-4593-8c71-2db50aaac4bc","exec":["var jsonData = pm.response.json();","pm.collectionVariables.set(\"x_auth_key\", jsonData.data.user.key.auth_key);","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"1940cf24-c173-4b7f-841c-966456175ddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"verify_id\": 113,\n \"code\": 123456\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/verify","description":"

Verify endpoint should be used as the second step to verify the user registration or login with verify_id and code.

Request:

{\n    \"verify_id\": 113,\n    \"code\": 123456\n}\n

verify_id unique verification id received from login or registration success response.
code 6 digit verification code.

Response:

{\n    \"status\": true,\n    \"data\": {\n        \"user\": {\n            \"id\": \"692ee113-310b-4e66-b5b5-33796f9616e3\",\n            \"first_name\": \"Charles\",\n            \"last_name\": \"Pearson\",\n            \"email\": \"your_name@example.com\",\n            \"profile_pic\": \"\",\n            \"email_verified\": true,\n            \"key\": {\n                \"auth_key\": \"<AUTH_KEY>\",\n                \"refresh_key\": \"<REFRESH_KEY>\"\n            }\n        }\n    }\n}\n

keys
auth_key authorization key of the user. expires in 30 minutes.
refresh_key refresh key to refresh the auth token when auth key is expired. refer to the Token Refresh endpoint on how to refresh token.

\n","urlObject":{"path":["v1","users","verify"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"1940cf24-c173-4b7f-841c-966456175ddd"},{"name":"Users List","event":[{"listen":"test","script":{"id":"acc4d5eb-2261-4516-9178-a8931b3b8997","exec":["pm.test(\"Retrieve list of users\", function () {"," // Send the request"," pm.sendRequest({"," url: 'https://api.tradly.app/v1/users?page={{page}}&per_page={{per_page}}',"," method: 'GET'"," }, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Assert that the response has a status code of 200"," pm.response.to.have.status(200);"," });","});",""],"type":"text/javascript"}}],"id":"a72d365c-a2fd-456d-99bb-a74ea9ffbc07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users?page={{page}}&per_page={{per_page}}","description":"

[ADMIN]

\n\n

Lists all the users ordered by latest date and time.

Query Parameters

\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

name	required	type	description
`page`	required	`integer`	pagination starts from 1
`per_page`	optional	`integer`	number of records per page. between 1 and 100
`created_from`	optional	`date`	filter users created from this date. example: 2020-02-28T10:00:00Z
`created_to`	optional,	`date`	filter users created until this date. example: 2021-02-13T12:00:00Z
`search_key`	optional	`string`	search users based on email, mobile, first name, and last name

","urlObject":{"path":["v1","users"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

page number starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

number of records to return in a page

\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"}],"variable":[]}},"response":[],"_postman_id":"a72d365c-a2fd-456d-99bb-a74ea9ffbc07"},{"name":"User Detail","event":[{"listen":"test","script":{"id":"bf6e72ea-d9bf-48f6-a865-da5ac027f739","exec":["pm.test(\"Test GET user by id\", function () {"," // Set the baseURL variable to the hostname of the API"," pm.variables.set('baseURL', 'https://api.tradly.app');",""," // Set the requestURL variable to the full URL of the request"," pm.variables.set('requestURL', `{{baseURL}}/v1/users/{{user_id}}`);",""," // Set the authKey variable to the x-auth-key header value"," pm.variables.set('authKey', '{{x-auth-key}}');",""," // Set the request method to GET"," pm.variables.set('requestMethod', 'GET');",""," // Set the request headers"," pm.variables.set('requestHeaders', {"," 'Content-Type': 'application/json',"," 'x-auth-key': '{{authKey}}'"," });",""," // Send the request"," pm.sendRequest({"," url: '{{requestURL}}',"," method: '{{requestMethod}}',"," headers: '{{requestHeaders}}'"," }, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Set the user_id variable to the returned id in the response"," pm.environment.set('user_id', res.json().user.id);"," });",""," // Check that the response has a 200 status code"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"012e9ade-87be-4a53-b308-c95ddb745c0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/{{user_id}}","description":"

Get user by user id.

{{user_id}} unique user id of the user

Response:

{\n    \"status\": true,\n    \"data\": {\n        \"user\": {\n            \"id\": \"692ee113-310b-4e66-b5b5-33796f9616e3\",\n            \"first_name\": \"Charles\",\n            \"last_name\": \"Pearson\",\n            \"email\": \"your_name@example.com\",\n            \"profile_pic\": \"\",\n            \"email_verified\": true\n        }\n    }\n}\n

\n","urlObject":{"path":["v1","users","{{user_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"012e9ade-87be-4a53-b308-c95ddb745c0a"},{"name":"Account Followers","event":[{"listen":"test","script":{"id":"97d36593-f86b-4098-826b-7e20864995a1","exec":["pm.test(\"Get user list\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);",""," // Parse the response body"," var jsonData = pm.response.json();",""," // Check that the response has a user object"," pm.expect(jsonData).to.have.property('user');",""," // Check that the user object has the expected properties"," var user = jsonData.user;"," pm.expect(user).to.have.all.keys("," 'uuid',"," 'first_name',"," 'last_name',"," 'email',"," 'type',"," 'created_at',"," 'updated_at'"," );","});",""],"type":"text/javascript"}}],"id":"98ee71c3-7983-458a-9fc6-8a212cc4e92c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/account_followers/{{account_id}}?page={{page}}&per_page={{per_page}}","description":"

Get followers(users) of an account.

💡 useful for social commerce

Path Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
`account_id`	`integer`	unique identifier of the account

","urlObject":{"path":["v1","users","account_followers","{{account_id}}"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

page number starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

number of reccords to return in a page

\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"}],"variable":[]}},"response":[],"_postman_id":"98ee71c3-7983-458a-9fc6-8a212cc4e92c"},{"name":"Token Refresh","id":"74bf642b-666e-4ca3-a771-01fdb9b91b64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Refresh-Key","value":"{{x_refresh_key}}","type":"text","description":"

refresh key rececived from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/token/refresh","description":"

Refreshes auth token.

\n","urlObject":{"path":["v1","users","token","refresh"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"74bf642b-666e-4ca3-a771-01fdb9b91b64"},{"name":"Update User","id":"8145e971-ce79-49bf-8190-8276071ea4c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"first_name\": \"Charles\",\n \"last_name\": \"Pearson\",\n \"profile_pic\": \"https://cdn.icon-icons.com/icons2/1378/PNG/512/avatardefault_92824.png\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/{{user_id}}","description":"

Update user details.

Request:

{\n    \"user\": {\n        \"first_name\": \"Charles\",\n        \"last_name\": \"Pearson\",\n        \"profile_pic\": \"https://cdn.icon-icons.com/icons2/1378/PNG/512/avatardefault_92824.png\"\n    }\n}\n

first_name first name of the user.
last_name last name of the user.
profile_pic profile picture URL of the user.

\n","urlObject":{"path":["v1","users","{{user_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"8145e971-ce79-49bf-8190-8276071ea4c0"},{"name":"Logout","id":"93e73ba0-7cba-41cb-b4f4-3b1c9bbc511d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/users/logout","description":"

Logs out user and clears session.

Request

{\n    \"uuid\": \"22607f28-815f-4448-a66d-333a755f932b\"\n}\n

uuid UUID provided while register/login.

\n","urlObject":{"path":["v1","users","logout"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"93e73ba0-7cba-41cb-b4f4-3b1c9bbc511d"}],"id":"e538a7c8-5974-4b45-ad8a-049b1dcf93fa","_postman_id":"e538a7c8-5974-4b45-ad8a-049b1dcf93fa","description":""},{"name":"Accounts","item":[{"name":"Add Account","event":[{"listen":"test","script":{"id":"c9ae2532-2628-4c4b-b2c9-c467f224eb77","exec":["pm.test(\"Create Account Test\", function () {"," // Ensure the response has a status of 201 (created)"," pm.response.to.have.status(200);",""," // Get the response body"," var body = pm.response.json();",""," // Assert that the response body has an account object with an id field"," pm.expect(body).to.have.property(\"account\");"," pm.expect(body.account).to.have.property(\"id\");",""," // Set the account_id variable to the id field in the response body"," pm.variables.set(\"account_id\", body.account.id);",""," // Assert that the account_id variable has been set"," pm.expect(pm.variables.has(\"account_id\")).to.be.true;","});",""],"type":"text/javascript"}}],"id":"f93c26ba-0f28-4745-b644-75d06f3eaf06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"account\": {\n \"id\": 26,\n \"name\": \"Urth Cafe\",\n \"unique_name\": \"urthcafe\",\n \"coordinates\": {\n \"latitude\": 37.7646541,\n \"longitude\": -122.4590515\n },\n \"description\": \"Urth Caffé has sought to provide only the finest and most exquisite culinary experiences for our customers. We always strive to touch the hearts, minds, and taste buds of our patrons by maintaining exceptional quality, ethics and above all bringing our customers the best-tasting food, organic heirloom coffees, and fine teas from all around the globe.\",\n \"images\": [\n \"https://storage.googleapis.com/tradlyapp/images/99244/a6f13815-d4c9-42e8-ab76-013a2469e03e.jpeg\"\n ],\n \"type\": \"accounts\",\n \"shipping_methods\": [\n 1\n ],\n \"attributes\": [\n {\n \"values\": [\n \"9626137045\"\n ],\n \"id\": 52\n }\n ],\n \"metadata\": {\n \"custom_data\": \"great_coffee\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts","description":"

Add an account.

Request

\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

name	required	type	description
`name`	required	`string`	name of the account
`description`	optional	`string`	description of the account
`unique_name`	optional	`string`	unique name for the account. a friendly name to uniquely identify the account
`images`	optional	`array`	array of image URLs
`coordinates`	required	`object`	geolocation of the account. refer coordinates object
`shipping_methods`	optional	`array`	array of shipping methods to be associated with this account. array of shipping method identifiers
`attributes`	optional	`array`	attributes of the account. tough it's optional when some attributes are marked as mandatory, it has to be passed as part of the request. see below to learn more on how to pass attribute values for different field types
`metadata`	optional	`json`	custom metadata that you want to save to this account
`type`	required	`string`	type of the object being returned

","urlObject":{"path":["v1","accounts"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"f93c26ba-0f28-4745-b644-75d06f3eaf06"},{"name":"Edit Account","event":[{"listen":"test","script":{"id":"b64fac9d-e68d-4be1-81cc-fa226e294e04","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"6796897d-cc00-49e3-892a-e1e34fdc9253","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

Edit an existing account.

Request

\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

name	required	type	description
`name`	required	`string`	name of the account
`description`	optional	`string`	description of the account
`unique_name`	optional	`string`	unique name for the account. a friendly name to uniquely identify the account
`images`	optional	`array`	array of image URLs
`coordinates`	required	`object`	geolocation of the account. refer coordinates object
`shipping_methods`	optional	`array`	array of shipping methods to be associated with this account. array of shipping method identifiers
`attributes`	optional	`array`	attributes of the account. tough it's optional when some attributes are marked as mandatory, it has to be passed as part of the request. see below to learn more on how to pass attribute values for different field types
`metadata`	optional	`json`	custom metadata that you want to save to this account
`type`	required	`string`	type of the object being returned

","urlObject":{"path":["v1","accounts","{{account_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6796897d-cc00-49e3-892a-e1e34fdc9253"},{"name":"Patch Account","id":"3a6bbc2b-c167-4fee-8f7f-0fd45ccee43e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"account\": {\n \"active\" : true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts/{{account_id}}","description":"

Update an account active status.

Note: As of now PATCH request supports only one data to be changed which is active. We are working on supporting other keys as well.

\n","urlObject":{"path":["v1","accounts","{{account_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a6bbc2b-c167-4fee-8f7f-0fd45ccee43e"},{"name":"Account List","event":[{"listen":"test","script":{"id":"63217081-1d65-423e-be3e-122df6f4fe55","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"dca7dd7e-a370-448c-9778-a46ef066977d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

OPTIONAL - user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts?page={{page}}&type={{type}}","description":"

Get accounts list.

Query Parameters

\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

name	required	type	description
`page`	required	`integer`	pagination starts from 1
`type`	required	`string`	type of the object being returned
`per_page`	optional	`integer`	number of records per page. between 1 and 100
`category_id`	optional	`string`	filter by category id. for more than one category, send as comma separated
`user_id`	optional	`string`	filter by user id
`search_key`	optional	`string`	search accounts by keyword
`max_distance`	optional	`number`	positive number. filter accounts by nearest distance. Example: to get all accounts less than 5 Kilometers. This works only when the current latitude and longitude of the user are sent in the query parameters.
`latitude`	optional	`double`	latitude of the geolocation
`latitude`	optional	`double`	longitude of the geolocation
`status`	optiona	`integer`	filter by account status

","urlObject":{"path":["v1","accounts"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

REQUIRED. pagination starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

REQUIRED. type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"dca7dd7e-a370-448c-9778-a46ef066977d"},{"name":"Account Detail","event":[{"listen":"test","script":{"id":"c7ccc07a-3ea0-46c3-872c-19fa162ed9a2","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"00c80ddb-5914-4d1c-9b82-ca0efafa6d1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

OPTIONAL - user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts/{{account_id}}","urlObject":{"path":["v1","accounts","{{account_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"00c80ddb-5914-4d1c-9b82-ca0efafa6d1f"},{"name":"Block Account","event":[{"listen":"test","script":{"id":"0fcfe8f4-f63d-421f-898f-fe3a981c66d9","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"04bc988b-a675-400f-8076-c44fe0713333","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts/{{account_id}}/block","description":"

Block an account. Upon successful response currently, logged-in user have successfully blocked the account mentioned in the endpoint.

💡 useful for social commerce

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`account_id`	required	`integer`	unique identifier of the account

","urlObject":{"path":["v1","accounts","{{account_id}}","block"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"04bc988b-a675-400f-8076-c44fe0713333"},{"name":"Moderate Account","event":[{"listen":"test","script":{"id":"c9cc62fc-fe21-40c1-b43c-120bd5d384a4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"005c0ab3-a3e8-4110-8878-55f151c00bf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"account\": {\n \"status\" : 3\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts/{{account_id}}/moderate","description":"

Moderate an account. All the new accounts created will be in 'waiting for approval' state. You can approve or reject using this endpoint. You can approve accounts from superadmin as well. To know more about the status click here.

To auto approve while creating the accounts, goto Settings > Accounts > Configuration and enable Account Auto Approval

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`account_id`	required	`integer`	unique identifier of the account

","urlObject":{"path":["v1","accounts","{{account_id}}","moderate"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"005c0ab3-a3e8-4110-8878-55f151c00bf0"}],"id":"65258420-75cd-4060-81e2-f05a7c4183eb","description":"

The Accounts API allows you to create, retrieve, update, and delete account information for your Tradly app.

Accounts means varies by your marketplace type. Like sellers, campaign owners, multi vendors, merchants, tutor, etc who will be able to post listings using your marketplace.

To create a new account, use the POST method and include the relevant account information in the request body as a JSON object.

To retrieve a list of accounts, use the GET method and specify any optional query parameters such as page and per_page in the request URL.

To update an existing account, use the PUT method and include the updated account information in the request body.

To delete an account, use the DELETE method and specify the id of the account in the request URL.

Manage accounts. Learn more about Accounts.

Account Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
`1`	waiting for approval
`2`	approved
`3`	rejected

Object

{\n    \"id\": 26,\n    \"name\": \"Urth Cafe\",\n    \"location\": {\n        \"city\": \"San Francisco\",\n        \"state\": \"California\",\n        \"country\": \"United States\",\n        \"locality\": \"\",\n        \"postcode\": \"94118\",\n        \"country_code\": \"us\",\n        \"formatted_address\": \"50 Hagiwara Tea Garden Dr, San Francisco, CA 94118, United States\"\n    },\n    \"shipping_methods\": [\n        {\n            \"id\": 1,\n            \"name\": \"Pick Up\",\n            \"logo_path\": \"\",\n            \"type\": \"pickup\",\n            \"default\": true,\n            \"active\": true,\n            \"order_by\": 1\n        }\n    ],\n    \"unique_name\": \"urthcafe\",\n    \"coordinates\": {\n        \"latitude\": 37.7646541,\n        \"longitude\": -122.4590515\n    },\n    \"description\": \"Urth Caffé has sought to provide only the finest and most exquisite culinary experiences for our customers. We always strive to touch the hearts, minds, and taste buds of our patrons by maintaining exceptional quality, ethics and above all bringing our customers the best-tasting food, organic heirloom coffees, and fine teas from all around the globe.\",\n    \"total_followers\": 3,\n    \"total_listings\": 1,\n    \"images\": [\n       \"https://storage.googleapis.com/tradlyapp/images/99244/a6f13815-d4c9-42e8-ab76-013a2469e03e.jpeg\"\n    ],\n    \"type\": \"accounts\",\n    \"active\": true,\n    \"status\": 2,\n    \"following\": false,\n    \"user\": {\n        \"id\": \"692ee113-310b-4e66-b5b5-33796f9616e3\",\n        \"first_name\": \"Charles\",\n        \"last_name\": \"Pearson\",\n        \"profile_pic\": \"\",\n        \"email\": \"your_name@example.com\",\n        \"mobile\": \"7700900493\",\n        \"dial_code\": \"44\",\n        \"created_at\": 1588524348,\n        \"updated_at\": 1607535465\n    },\n    \"rating_data\": {\n        \"rating_average\": 0\n    }\n}\n\n

Account Object

\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

name	type	description
`id`	`integer`	unique id of the account
`name`	`string`	name of the account
`description`	`string`	description of the account
`unique_name`	`string`	unique name for the account. a friendly name to uniquely identify the account
`images`	`array`	array of image URLs
`location`	`object`	location information of the account. refer to a location object below for more information
`shipping_methods`	`array`	array of shipping methods associated with this account. refer to shipping method object for more information
`following`	`boolean`	whether currently logged in user is following this account or not
`status`	`integer`	current status of the account. refer to status legend for more information
`active`	`boolean`	states whether this category is active or not
`user`	`object`	user who created this account. refer to user object for more information
`rating_data`	`object`	rating information of the account. refer to rating object for more information
`coordinates`	`object`	geolocation of the account
`type`	`string`	type of the object being returned

Location Object

\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

name	type	description
`city`	`string`	city of the location
`country`	`string`	country name of the location
`country_code`	`string`	ISO alpha-2 country code
`locality`	`string`	locality of the location
`postcode`	`string`	postal/zip code of the location
`state`	`string`	state/province of the location
`formatted_address`	`string`	fully formatted address of the location

","event":[{"listen":"prerequest","script":{"id":"318a7f4b-04fe-4990-9a56-8a4c33172645","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3e8a7504-cf33-438e-b02a-cdf4428b47a8","type":"text/javascript","exec":[""]}}],"_postman_id":"65258420-75cd-4060-81e2-f05a7c4183eb"},{"name":"Catalogue","item":[{"name":"Listings","item":[{"name":"Add Listing","event":[{"listen":"test","script":{"id":"721f2714-d089-44ba-9acf-4ebb80ad4401","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"dac9bc68-12f5-471f-810f-b39d951827fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"listing\": {\n \"list_price\": 50,\n \"description\": \"Test\",\n \"account_id\": 26,\n \"currency_id\": 13,\n \"stock\": 2,\n \"sku\": \"JH105\",\n \"barcode\": \"69016541889113\",\n \"attributes\": [\n {\n \"values\": [\n \"one\",\n \"two\",\n \"three\",\n \"four_five_\"\n ],\n \"id\": 71\n }\n ],\n \"title\": \"Tags testing \",\n \"offer_percent\": 0,\n \"images\": [\n \"https:\\/\\/storage.googleapis.com\\/tradlyapp\\/images\\/73717\\/9dc9f94e-270b-42bd-bfaa-60b1fa039669.png\"\n ],\n \"category_id\": [\n 257\n ],\n \"coordinates\": {\n \"latitude\": 10.0790473,\n \"longitude\": 78.7816108\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings","description":"

tags & offer_percent are optional

atleast one image is mandatory

Error Codes

CODE_STORE_NOT_FOUND = 330

CODE_CATEGORY_NOT_FOUND = 331

CODE_MISSING_ATTRIBUTES = 332

CODE_INVALID_ATTRIBUTES = 333

\n","urlObject":{"path":["products","v1","listings"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"dac9bc68-12f5-471f-810f-b39d951827fd"},{"name":"Edit Listing","event":[{"listen":"test","script":{"id":"bd5a73db-360a-4b7c-aa8b-daefbec5aec7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should include updated listing information\", function () {"," var jsonResponse = pm.response.json();"," pm.expect(jsonResponse.listing.list_price).to.eql(50);"," pm.expect(jsonResponse.listing.description).to.eql(\"Test\");"," pm.expect(jsonResponse.listing.account_id).to.eql(26);"," pm.expect(jsonResponse.listing.currency_id).to.eql(13);"," pm.expect(jsonResponse.listing.stock).to.eql(5);"," pm.expect(jsonResponse.listing.sku).to.eql(\"JH105\");"," pm.expect(jsonResponse.listing.barcode).to.eql(\"69016541889113\");"," pm.expect(jsonResponse.listing.attributes).to.have.lengthOf(1);"," pm.expect(jsonResponse.listing.attributes[0].values).to.eql(["," \"one\","," \"two\","," \"three\","," \"four_five_\""," ]);"," pm.expect(jsonResponse.listing.title).to.eql(\"Tags testing 1\");"," pm.expect(jsonResponse.listing.offer_percent).to.eql(0);"," pm.expect(jsonResponse.listing.images).to.have.lengthOf(1);"," pm.expect(jsonResponse.listing.images[0]).to.eql(\"https:\\/\\/storage.googleapis.com\\/tradlyapp\\/images\\/73717\\/9dc9f94e-270b-42bd-bfaa-60b1fa039669.png\");"," pm.expect(jsonResponse.listing.category_id).to.have.lengthOf(1);"," pm.expect(jsonResponse.listing.category_id[0]).to.eql(257);"," pm.expect(jsonResponse.listing.coordinates.latitude).to.eql(10.0790473);"," pm.expect(jsonResponse.listing.coordinates.longitude).to.eql(78.7816108);","});",""],"type":"text/javascript"}}],"id":"15ebd5d2-707f-45cc-91ce-8013313efe0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"listing\": {\n \"list_price\": 50,\n \"description\": \"Test\",\n \"account_id\": 26,\n \"currency_id\": 13,\n \"stock\": 5,\n \"sku\": \"JH105\",\n \"barcode\": \"69016541889113\",\n \"attributes\": [\n {\n \"values\": [\n \"one\",\n \"two\",\n \"three\",\n \"four_five_\"\n ],\n \"id\": 71\n }\n ],\n \"title\": \"Tags testing 1\",\n \"offer_percent\": 0,\n \"images\": [\n \"https:\\/\\/storage.googleapis.com\\/tradlyapp\\/images\\/73717\\/9dc9f94e-270b-42bd-bfaa-60b1fa039669.png\"\n ],\n \"category_id\": [\n 257\n ],\n \"coordinates\": {\n \"latitude\": 10.0790473,\n \"longitude\": 78.7816108\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}","description":"

tags & offer_percent are optional

atleast one image is mandatory

Error Codes

CODE_STORE_NOT_FOUND = 330

CODE_CATEGORY_NOT_FOUND = 331

CODE_MISSING_ATTRIBUTES = 332

CODE_INVALID_ATTRIBUTES = 333

CODE_LISTING_NOT_FOUND = 335

\n","urlObject":{"path":["products","v1","listings","{{listing_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"15ebd5d2-707f-45cc-91ce-8013313efe0f"},{"name":"Listings List","event":[{"listen":"test","script":{"id":"e2d09093-0876-4398-ab66-04ad0bab0c40","exec":["pm.test(\"Test GET /products/v1/listings endpoint\", function () {"," // Set the baseURL variable to the hostname of the API"," pm.variables.set('baseURL', 'https://api.tradly.app');",""," // Set the requestURL variable to the full URL of the request"," pm.variables.set('requestURL', `{{baseURL}}/products/v1/listings?page=1&per_page=30&price_from=10&sort=relevance`);",""," // Set the authKey variable to the x-auth-key header value"," pm.variables.set('authKey', '{{x-auth-key}}');",""," // Set the request method to GET"," pm.variables.set('requestMethod', 'GET');",""," // Set the request headers"," pm.variables.set('requestHeaders', {"," 'Content-Type': 'application/json',"," 'X-Auth-Key': '{{authKey}}',"," 'X-Language': 'en'"," });",""," // Send the request"," pm.sendRequest({"," url: '{{requestURL}}',"," method: '{{requestMethod}}',"," headers: '{{requestHeaders}}'"," }, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Assert that the response has a 200 status code"," pm.response.to.have.status(200);",""," // Assert that the response is a valid JSON"," pm.expect(res.json()).to.be.an('object');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"d929750b-182c-4afc-999d-116fb532a320","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"},{"key":"X-Language","value":"en","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings?page={{page}}&per_page={{per_page}}&price_from=10&price_to=20&search_key=milk&sort=relevance&category_id=231&account_id=1&attribute_value_id=1,2","urlObject":{"path":["products","v1","listings"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

page is mandatory starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

number of records to return in each page. default 30. max 100.

\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"},{"description":{"content":"

from price to filter

\n","type":"text/plain"},"key":"price_from","value":"10"},{"description":{"content":"

to price to filter

\n","type":"text/plain"},"key":"price_to","value":"20"},{"description":{"content":"

search keyword

\n","type":"text/plain"},"key":"search_key","value":"milk"},{"description":{"content":"

sort values: 'relevance' 'price_high_to_low' 'price_low_to_high' 'newest_first' 'oldest_first'

\n","type":"text/plain"},"key":"sort","value":"relevance"},{"description":{"content":"

category to filter

\n","type":"text/plain"},"key":"category_id","value":"231"},{"description":{"content":"

account id to filter

\n","type":"text/plain"},"key":"account_id","value":"1"},{"description":{"content":"

comma separated attribute value ids

\n","type":"text/plain"},"key":"attribute_value_id","value":"1,2"}],"variable":[]}},"response":[],"_postman_id":"d929750b-182c-4afc-999d-116fb532a320"},{"name":"Listing Detail","event":[{"listen":"test","script":{"id":"85d1f940-8a35-4d4f-9ae4-85e762f6cee5","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should include updated listing information\", function () {"," var jsonResponse = pm.response.json();"," pm.expect(jsonResponse.listing.list_price).to.eql(50);"," pm.expect(jsonResponse.listing.description).to.eql(\"Test\");"," pm.expect(jsonResponse.listing.account_id).to.eql(26);"," pm.expect(jsonResponse.listing.currency_id).to.eql(13);"," pm.expect(jsonResponse.listing.stock).to.eql(5);"," pm.expect(jsonResponse.listing.sku).to.eql(\"JH105\");"," pm.expect(jsonResponse.listing.barcode).to.eql(\"69016541889113\");"," pm.expect(jsonResponse.listing.attributes).to.have.lengthOf(1);"," pm.expect(jsonResponse.listing.attributes[0].values).to.eql(["," \"one\","," \"two\","," \"three\","," \"four_five_\""," ]);"," pm.expect(jsonResponse.listing.title).to.eql(\"Tags testing 1\");"," pm.expect(jsonResponse.listing.offer_percent).to.eql(0);"," pm.expect(jsonResponse.listing.images).to.have.lengthOf(1);"," pm.expect(jsonResponse.listing.images[0]).to.eql(\"https:\\/\\/storage.googleapis.com\\/tradlyapp\\/images\\/73717\\/9dc9f94e-270b-42bd-bfaa-60b1fa039669.png\");"," pm.expect(jsonResponse.listing.category_id).to.have.lengthOf(1);"," pm.expect(jsonResponse.listing.category_id[0]).to.eql(257);"," pm.expect(jsonResponse.listing.coordinates.latitude).to.eql(10.0790473);"," pm.expect(jsonResponse.listing.coordinates.longitude).to.eql(78.7816108);","});",""],"type":"text/javascript"}}],"id":"8cb94579-f83b-42cf-a2e1-c02a2b84e380","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"},{"key":"X-Language","value":"en","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}","description":"

/app/products/v1/c2c/listings/{listing_id}

keyword to get suggestions

\n","type":"text/plain"},"key":"keyword","value":"brownies"},{"description":{"content":"

max of 50 suggestions

\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"bacbf20d-5be9-4adc-9f46-10293b0e0077"},{"name":"Delete Listing","event":[{"listen":"test","script":{"id":"99068b1f-f026-43ea-ad66-d76a83ccaecc","exec":["pm.test(\"Test DELETE listing\", function() {"," pm.response.to.have.status(200);"," pm.response.to.be.json;","});",""],"type":"text/javascript"}}],"id":"ae07ee4c-a0da-42ec-9287-d4dadf0731e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}","urlObject":{"path":["products","v1","listings","{{listing_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae07ee4c-a0da-42ec-9287-d4dadf0731e2"},{"name":"Mark as Sold","event":[{"listen":"test","script":{"id":"5be20694-eacf-4633-bfb2-0e46e5381218","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"f2c7de8a-cf94-452d-a37f-cc5f5a7d6e4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/sold","description":"

tags & offer_percent are optional

atleast one image is mandatory

Error Codes

CODE_STORE_NOT_FOUND = 330

CODE_CATEGORY_NOT_FOUND = 331

CODE_MISSING_ATTRIBUTES = 332

CODE_INVALID_ATTRIBUTES = 333

\n","urlObject":{"path":["products","v1","listings","{{listing_id}}","sold"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2c7de8a-cf94-452d-a37f-cc5f5a7d6e4c"},{"name":"Moderate Listings","event":[{"listen":"test","script":{"id":"c9106e17-6ba3-4d92-be51-b3d050bb6cda","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be in JSON format\", function () {"," pm.response.to.have.headers({"," \"Content-Type\": \"application/json\""," });","});","","pm.test(\"Response should not be empty\", function () {"," pm.expect(pm.response.text()).to.not.be.empty;","});","","pm.test(\"Response should contain the modified listing object\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property(\"listing\");"," pm.expect(jsonData.listing).to.have.property(\"status\", 2);","});",""],"type":"text/javascript"}}],"id":"b8d9570e-240d-4ce4-bd05-0a6934693c3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"listing\": {\n \"status\": 2\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/moderate","description":"

Accepted Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Desription
2	APPROVED
3	REJECTED

","urlObject":{"path":["products","v1","listings","{{listing_id}}","moderate"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8d9570e-240d-4ce4-bd05-0a6934693c3d"},{"name":"Listings Likes","event":[{"listen":"test","script":{"id":"4a597570-2c55-4c9c-9114-126031be6a10","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Response should contain 'likes' property\", function () {"," pm.expect(pm.response.json().likes).to.exist;","});",""],"type":"text/javascript"}}],"id":"e8633904-6932-4074-aa88-d966b57344eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/likes?page={{page}}&per_page={{per_page}}","description":"

page is mandatory starts from 1

optional:

per_page default value is 30. Value can be upto 100

\n","urlObject":{"path":["products","v1","listings","likes"],"host":["https://api.tradly.app"],"query":[{"key":"page","value":"{{page}}"},{"key":"per_page","value":"{{per_page}}"}],"variable":[]}},"response":[],"_postman_id":"e8633904-6932-4074-aa88-d966b57344eb"},{"name":"Unique Locations","event":[{"listen":"test","script":{"id":"f3a81b3f-8945-4128-86f7-f5463a24f447","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON object\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.equal(\"application/json; charset=utf-8\");","});","","pm.test(\"Response should contain a list of locations\", function () {"," var jsonResponse = pm.response.json();"," pm.expect(Array.isArray(jsonResponse)).to.be.true;","});",""],"type":"text/javascript"}}],"id":"5acfa269-bd91-4459-b942-0e627c1941ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/unique/locations","description":"

page is mandatory starts from 1

optional:

per_page default value is 30. Value can be upto 100

\n","urlObject":{"path":["products","v1","listings","unique","locations"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"5acfa269-bd91-4459-b942-0e627c1941ac"},{"name":"Listings Schedules Per Day","event":[{"listen":"test","script":{"id":"589a5284-40a4-4fa7-8b06-4bfb8d57497f","exec":["pm.test(\"Status code is 200\", function () {","pm.response.to.have.status(200);","});","","pm.test(\"Response body is a JSON object\", function () {","pm.expect(pm.response.text()).to.be.a('string');","pm.expect(function () {","JSON.parse(pm.response.text())","}).to.not.throw();","});","","pm.test(\"Response body has required properties\", function () {","var json = JSON.parse(pm.response.text());","pm.expect(json).to.have.property('data');","pm.expect(json.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"29cf7ece-bf88-4974-b539-118c6e0a42f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/schedules_per_day","description":"

page is mandatory starts from 1

optional:

per_page default value is 30. Value can be upto 100

\n","urlObject":{"path":["products","v1","listings","{{listing_id}}","schedules_per_day"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"29cf7ece-bf88-4974-b539-118c6e0a42f4"},{"name":"Create Negotiations","event":[{"listen":"test","script":{"id":"589a5284-40a4-4fa7-8b06-4bfb8d57497f","exec":["pm.test(\"Status code is 200\", function () {","pm.response.to.have.status(200);","});","","pm.test(\"Response body is a JSON object\", function () {","pm.expect(pm.response.text()).to.be.a('string');","pm.expect(function () {","JSON.parse(pm.response.text())","}).to.not.throw();","});","","pm.test(\"Response body has required properties\", function () {","var json = JSON.parse(pm.response.text());","pm.expect(json).to.have.property('data');","pm.expect(json.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"4c6f7ca7-c99c-49c7-8f9d-be63bc7dea8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"negotiation\": {\n \"price\": 30\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/negotiations","description":"

price is the amount buyer willing to pay for the listing.

\n","urlObject":{"path":["products","v1","listings","{{listing_id}}","negotiations"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c6f7ca7-c99c-49c7-8f9d-be63bc7dea8b"},{"name":"Update Negotiation Status","event":[{"listen":"test","script":{"id":"589a5284-40a4-4fa7-8b06-4bfb8d57497f","exec":["pm.test(\"Status code is 200\", function () {","pm.response.to.have.status(200);","});","","pm.test(\"Response body is a JSON object\", function () {","pm.expect(pm.response.text()).to.be.a('string');","pm.expect(function () {","JSON.parse(pm.response.text())","}).to.not.throw();","});","","pm.test(\"Response body has required properties\", function () {","var json = JSON.parse(pm.response.text());","pm.expect(json).to.have.property('data');","pm.expect(json.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"6abcdc82-8638-4320-80fd-9761996e2b42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"negotiation\": {\n \"status\": 2\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/negotiations/{{negotiation_id}}","description":"

`status` is the status seller wishes to set for the negotiation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Desription
2	APPROVED
3	REJECTED

","urlObject":{"path":["products","v1","listings","{{listing_id}}","negotiations","{{negotiation_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6abcdc82-8638-4320-80fd-9761996e2b42"},{"name":"Reported Listings [ADMIN]","event":[{"listen":"test","script":{"id":"4a597570-2c55-4c9c-9114-126031be6a10","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Response should contain 'likes' property\", function () {"," pm.expect(pm.response.json().likes).to.exist;","});",""],"type":"text/javascript"}}],"id":"488d9d47-a611-4d91-bb63-83e344d809ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/reported/list?page={{page}}&per_page={{per_page}}","description":"

page is mandatory starts from 1

optional:

per_page default value is 30. Value can be upto 100

\n","urlObject":{"path":["products","v1","listings","reported","list"],"host":["https://api.tradly.app"],"query":[{"key":"page","value":"{{page}}"},{"key":"per_page","value":"{{per_page}}"}],"variable":[]}},"response":[],"_postman_id":"488d9d47-a611-4d91-bb63-83e344d809ba"}],"id":"58c0febe-f823-4c7c-a171-9de84fe33f39","description":"

Manage listings. Learn more about Listings.

Listing Object

\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
`id`	`integer`	unique id of the listing
`title`	`string`	title of the listing
`description`	`string`	description of the listing
`images`	`array`	an array of image URLs
`sku`	`string`	sku of the listing, it's auto-generated by default.
`barcode`	`string`	barcode of the listing, it's auto-generated by default.
`location`	`object`	location information of the listing. refer to a location object below for more information
`gtin`	`string`	Global Trade Item Number. Max. 20 characters
`mpn`	`string`	Manufacturer part number. Max. 40 characters.
`weight_uom`	`string`	Unit of measure for weight. Possible values are `pound` `ounce` `gram` `kilogram`
`weight_value`	`float`	value of the weight
`volume_uom`	`string`	Unit of measure for volume. Possible values are `liter` `milliliter`
`volume_value`	`float`	value of the volume
`size_uom`	`string`	Unit of measure for size. Possible values are `centimeter` `meter` `inch` `millimeter`
`height`	`float`	height of the listing
`length`	`float`	length of the listing
`width`	`float`	width of the listing
`seller_protection_fee_enabled`	`boolean`	whether the seller protection fee is enabled or not
`slug`	`string`	unique slug of the listing. useful for SEO
`meta_title`	`string`	meta title of the listing. useful for SEO
`meta_description`	`string`	meta description of the listing. useful for SEO
`meta_keyword`	`string`	meta keyword of the listing. useful for SEO
`in_cart`	`boolean`	whether the listing is present in cart or not
`liked`	`boolean`	whether the listing is liked by the currently logged in user or not
`active`	`boolean`	states whether this listing is active or not
`user`	`object`	user who created this listing. refer to user object for more information
`rating_data`	`object`	rating information of the listing. refer to rating object for more information
`coordinates`	`object`	geolocation of the listing
`shipping_charges`	`float`	shipping charge of the listing
`type`	`string`	type of the object being returned

","_postman_id":"58c0febe-f823-4c7c-a171-9de84fe33f39"},{"name":"Listing Variant Types","item":[{"name":"Listing Variant Types","event":[{"listen":"test","script":{"id":"fdc58a5d-c9ef-4dbe-9259-b4cf720959e8","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON object\", function () {"," pm.response.to.be.a('object');","});","","pm.test(\"Variant types array is not empty\", function () {"," pm.expect(pm.response.json().variant_types).to.be.an('array').that.is.not.empty;","});","","pm.test(\"Each variant type has required properties\", function () {"," pm.response.json().variant_types.forEach(function (variantType) {"," pm.expect(variantType).to.have.property('id');"," pm.expect(variantType).to.have.property('name');"," });","});",""],"type":"text/javascript"}}],"id":"6b479d35-571a-4d1a-bf88-a59a742a5820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types","urlObject":{"path":["products","v1","variant_types"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b479d35-571a-4d1a-bf88-a59a742a5820"},{"name":"Listing Variant Type Detail","event":[{"listen":"test","script":{"id":"a9b696a3-4bce-4440-9d08-66c875e4bcb8","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response body should be a valid JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Response should contain a variant type object\", function () {"," var jsonResponse = pm.response.json();"," pm.expect(jsonResponse).to.have.property(\"variant_type\");"," pm.expect(jsonResponse.variant_type).to.be.an(\"object\");","});",""],"type":"text/javascript"}}],"id":"72b481b4-2db7-4ade-9f68-c2464b1f5624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"72b481b4-2db7-4ade-9f68-c2464b1f5624"},{"name":"Add Listing Variant Type","event":[{"listen":"test","script":{"id":"7e4057a3-4eb0-4e7c-87e2-c273eb90071e","exec":["pm.test(\"Status code is 201\", function () {","pm.response.to.have.status(201);","});","","pm.test(\"Response should include a variant type object with the correct name, active status, and values\", function () {","pm.response.to.have.jsonBody(\"variant_type.name\", \"Size\");","pm.response.to.have.jsonBody(\"variant_type.active\", true);","pm.response.to.have.jsonBody(\"variant_type.values\", [\"Blue\",\"White\",\"Red\"]);","});"],"type":"text/javascript"}}],"id":"24521802-9d41-4560-9ffc-e1f85de72936","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"variant_type\": {\n \t\"name\" : \"Size\",\n \t\"active\" : true,\n \t\"values\" : [\"Blue\",\"White\",\"Red\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types","urlObject":{"path":["products","v1","variant_types"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"24521802-9d41-4560-9ffc-e1f85de72936"},{"name":"Edit Listing Variant Type","event":[{"listen":"test","script":{"id":"6f0dddc0-8029-471c-9aca-fc94c567d653","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"5fcd1832-e473-4748-9e6b-b1814edb19d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"variant_type\": {\n \t\"name\" : \"Color\",\n \t\"active\" : true,\n \t\"values\" : [\"Blue\",\"White\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"5fcd1832-e473-4748-9e6b-b1814edb19d3"},{"name":"Delete Listing Variant Type","event":[{"listen":"test","script":{"id":"369886bf-6954-4007-a0c6-76222874ab1a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"83d6cab7-568e-46ee-a512-ef39a63383c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"83d6cab7-568e-46ee-a512-ef39a63383c3"},{"name":"Listing Variant Type Values","event":[{"listen":"test","script":{"id":"fdc58a5d-c9ef-4dbe-9259-b4cf720959e8","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON object\", function () {"," pm.response.to.be.a('object');","});","","pm.test(\"Variant types array is not empty\", function () {"," pm.expect(pm.response.json().variant_types).to.be.an('array').that.is.not.empty;","});","","pm.test(\"Each variant type has required properties\", function () {"," pm.response.json().variant_types.forEach(function (variantType) {"," pm.expect(variantType).to.have.property('id');"," pm.expect(variantType).to.have.property('name');"," });","});",""],"type":"text/javascript"}}],"id":"3d2bd4bf-2284-44fc-b3b7-291a9a16d233","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}/values","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}","values"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d2bd4bf-2284-44fc-b3b7-291a9a16d233"},{"name":"Listing Variant Type Value Detail","event":[{"listen":"test","script":{"id":"fdc58a5d-c9ef-4dbe-9259-b4cf720959e8","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON object\", function () {"," pm.response.to.be.a('object');","});","","pm.test(\"Variant types array is not empty\", function () {"," pm.expect(pm.response.json().variant_types).to.be.an('array').that.is.not.empty;","});","","pm.test(\"Each variant type has required properties\", function () {"," pm.response.json().variant_types.forEach(function (variantType) {"," pm.expect(variantType).to.have.property('id');"," pm.expect(variantType).to.have.property('name');"," });","});",""],"type":"text/javascript"}}],"id":"2bbba71a-76c8-4256-bf05-701dc3e3fd05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}/values/{{variant_type_value_id}}","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}","values","{{variant_type_value_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"2bbba71a-76c8-4256-bf05-701dc3e3fd05"},{"name":"Add Listing Variant Type Value","event":[{"listen":"test","script":{"id":"7e4057a3-4eb0-4e7c-87e2-c273eb90071e","exec":["pm.test(\"Status code is 201\", function () {","pm.response.to.have.status(201);","});","","pm.test(\"Response should include a variant type object with the correct name, active status, and values\", function () {","pm.response.to.have.jsonBody(\"variant_type.name\", \"Size\");","pm.response.to.have.jsonBody(\"variant_type.active\", true);","pm.response.to.have.jsonBody(\"variant_type.values\", [\"Blue\",\"White\",\"Red\"]);","});"],"type":"text/javascript"}}],"id":"a1957c8f-c39f-439c-9c29-a8a2345935ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"variant_type\": {\n \"value\" : {\n \"name\" : \"L\",\n \"active\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}/values","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}","values"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1957c8f-c39f-439c-9c29-a8a2345935ca"},{"name":"Edit Listing Variant Type Value","event":[{"listen":"test","script":{"id":"7e4057a3-4eb0-4e7c-87e2-c273eb90071e","exec":["pm.test(\"Status code is 201\", function () {","pm.response.to.have.status(201);","});","","pm.test(\"Response should include a variant type object with the correct name, active status, and values\", function () {","pm.response.to.have.jsonBody(\"variant_type.name\", \"Size\");","pm.response.to.have.jsonBody(\"variant_type.active\", true);","pm.response.to.have.jsonBody(\"variant_type.values\", [\"Blue\",\"White\",\"Red\"]);","});"],"type":"text/javascript"}}],"id":"9dc323ec-a8ec-4214-828b-a3d827b324d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"variant_type\": {\n \"value\" : {\n \"name\" : \"L\",\n \"active\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}/values/{{variant_type_value_id}}","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}","values","{{variant_type_value_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"9dc323ec-a8ec-4214-828b-a3d827b324d4"},{"name":"Delete Listing Variant Type Value","event":[{"listen":"test","script":{"id":"7e4057a3-4eb0-4e7c-87e2-c273eb90071e","exec":["pm.test(\"Status code is 201\", function () {","pm.response.to.have.status(201);","});","","pm.test(\"Response should include a variant type object with the correct name, active status, and values\", function () {","pm.response.to.have.jsonBody(\"variant_type.name\", \"Size\");","pm.response.to.have.jsonBody(\"variant_type.active\", true);","pm.response.to.have.jsonBody(\"variant_type.values\", [\"Blue\",\"White\",\"Red\"]);","});"],"type":"text/javascript"}}],"id":"3cd94123-292e-455e-b203-83dbd8effe3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/variant_types/{{variant_type_id}}/values/{{variant_type_value_id}}","urlObject":{"path":["products","v1","variant_types","{{variant_type_id}}","values","{{variant_type_value_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cd94123-292e-455e-b203-83dbd8effe3c"}],"id":"86d77b6d-c8d9-4ced-812b-aec342575b84","event":[{"listen":"prerequest","script":{"id":"a7fc2065-a32c-4791-aa97-50d4cd3c97a8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f05b54f2-705d-473d-8a9b-42d5f0859373","type":"text/javascript","exec":[""]}}],"_postman_id":"86d77b6d-c8d9-4ced-812b-aec342575b84","description":""},{"name":"Listing Variants","item":[{"name":"Listing Variants","event":[{"listen":"test","script":{"id":"400fb803-1fcf-434f-902d-6916c72b75e2","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be an array\", function () {"," pm.expect(Array.isArray(pm.response.json())).to.be.true;","});","","pm.test(\"Response should contain variant objects\", function () {"," var variants = pm.response.json();"," variants.forEach(function (variant) {"," pm.expect(variant).to.have.property(\"id\");"," pm.expect(variant).to.have.property(\"listing_id\");"," pm.expect(variant).to.have.property(\"variant_values\");"," });","});",""],"type":"text/javascript"}}],"id":"6ef25616-4bf8-4f61-883f-97972ba2dd9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/variants","urlObject":{"path":["products","v1","listings","{{listing_id}}","variants"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ef25616-4bf8-4f61-883f-97972ba2dd9b"},{"name":"Listing Variant Detail","event":[{"listen":"test","script":{"id":"ffa31c66-d254-46a5-9e41-736a4f71579c","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a valid JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Variant object should have required fields\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property(\"id\");"," pm.expect(jsonData).to.have.property(\"product_id\");"," pm.expect(jsonData).to.have.property(\"price\");"," pm.expect(jsonData).to.have.property(\"currency_id\");"," pm.expect(jsonData).to.have.property(\"stock\");"," pm.expect(jsonData).to.have.property(\"variants\");","});",""],"type":"text/javascript"}}],"id":"dd958a59-8647-4df0-bbf3-944bc17aacf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/variants/{{variant_id}}","urlObject":{"path":["products","v1","listings","{{listing_id}}","variants","{{variant_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd958a59-8647-4df0-bbf3-944bc17aacf7"},{"name":"Add Listing Variant","event":[{"listen":"test","script":{"id":"7deee779-d2fc-4656-8c33-d6ee3a0601b0","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response body is not empty\", function () {"," pm.expect(pm.response.text()).to.not.be.empty;","});","","pm.test(\"Response should contain the variant details\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property(\"variant\");","});",""],"type":"text/javascript"}}],"id":"c8b2a969-822b-432a-a58b-2c992a2ba459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"variant\": {\n \"active\": true,\n \"stock\" : 2,\n \"title\": \"Add optional title Red\",\n \"description\": \"Add optional desccription L\",\n \"list_price\": 32,\n \"offer_percent\": 8,\n \"variant_values\": [\n {\n \"variant_type_id\": 4,\n \"variant_type_value_id\": 1\n },\n {\n \"variant_type_id\": 5,\n \"variant_type_value_id\": 2\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/variants","urlObject":{"path":["products","v1","listings","{{listing_id}}","variants"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8b2a969-822b-432a-a58b-2c992a2ba459"},{"name":"Edit Listing Variant","event":[{"listen":"test","script":{"id":"d5f71481-3eb0-4364-970c-b15442deb42c","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a valid JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Response should contain the updated variant\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.variant).to.have.property(\"title\", \"Some optional title edited\");"," pm.expect(jsonData.variant).to.have.property(\"description\", \"Some optional desccription\");"," pm.expect(jsonData.variant).to.have.property(\"list_price\", 38);"," pm.expect(jsonData.variant).to.have.property(\"offer_percent\", 10);"," pm.expect(jsonData.variant).to.have.property(\"variant_types\").with.lengthOf(1);"," pm.expect(jsonData.variant.variant_types[0]).to.have.property(\"type_id\", 1);"," pm.expect(jsonData.variant.variant_types[0]).to.have.property(\"values\").with.lengthOf(2);"," pm.expect(jsonData.variant.variant_types[0].values[0]).to.have.property(\"variant_value_id\", 1);"," pm.expect(jsonData.variant.variant_types[0].values[0]).to.have.property(\"value\", \"Yellow\");","","});",""],"type":"text/javascript"}}],"id":"9c93bd6e-bf97-400d-8c7d-87c78d4b6cc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"variant\": {\n \"active\": true,\n \"stock\" : 2,\n \"title\": \"Add optional title Red\",\n \"description\": \"Add optional desccription L\",\n \"list_price\": 32,\n \"offer_percent\": 8,\n \"variant_values\": [\n {\n \"variant_type_id\": 4,\n \"variant_type_value_id\": 1\n },\n {\n \"variant_type_id\": 5,\n \"variant_type_value_id\": 2\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/variants/{{variant_id}}","urlObject":{"path":["products","v1","listings","{{listing_id}}","variants","{{variant_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c93bd6e-bf97-400d-8c7d-87c78d4b6cc5"},{"name":"Delete Listing Variant","event":[{"listen":"test","script":{"id":"b38a983f-f817-48cf-9408-082c5dc19a11","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be empty\", function () {"," pm.expect(pm.response.text()).to.be.empty;","});",""],"type":"text/javascript"}}],"id":"3ddfb2b3-3d01-44bf-bc54-0105cda0b517","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/variants/{{variant_id}}","urlObject":{"path":["products","v1","listings","{{listing_id}}","variants","{{variant_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ddfb2b3-3d01-44bf-bc54-0105cda0b517"}],"id":"0bb8e7c8-6b2f-4d27-b814-073fbba6b2c3","_postman_id":"0bb8e7c8-6b2f-4d27-b814-073fbba6b2c3","description":""}],"id":"ab28517f-efa0-484c-b89d-903af0069384","event":[{"listen":"prerequest","script":{"id":"6134cd18-2c81-4383-a328-0865e8726f8c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2861397b-98a8-4a4f-b018-9ba5b6c25cbf","type":"text/javascript","exec":[""]}}],"_postman_id":"ab28517f-efa0-484c-b89d-903af0069384","description":""},{"name":"Social","item":[{"name":"Tags","item":[{"name":"Tags Search","event":[{"listen":"test","script":{"id":"9a9cf962-be6b-45d4-aa29-00f57f586344","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a valid JSON\", function () {"," pm.response.to.have.header(\"Content-Type\", \"application/json\");"," pm.response.to.be.json;","});","","pm.test(\"Response should contain the expected data\", function () {"," pm.response.to.have.jsonBody(\"key\", \"{{key}}\");"," pm.response.to.have.jsonBody(\"limit\", \"{{limit}}\");","});",""],"type":"text/javascript"}}],"id":"94681304-2ae6-4002-bcdc-8fb2fb810ee2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/tags/search?key={{key}}&limit={{limit}}","description":"

Search tags associated with listings.

Response

{\n    \"status\": true,\n    \"data\": {\n        \"tags\": [\n            {\n                \"id\": 53,\n                \"name\": \"Monstera\"\n            },\n            {\n                \"id\": 318,\n                \"name\": \"monstera\"\n            },\n            {\n                \"id\": 322,\n                \"name\": \"monstera adansonii\"\n            }\n        ]\n    }\n}\n

","urlObject":{"path":["v1","tags","search"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

REQUIRED. search keyword

\n","type":"text/plain"},"key":"key","value":"{{key}}"},{"description":{"content":"

OPTIONAL. number of search results to return

\n","type":"text/plain"},"key":"limit","value":"{{limit}}"}],"variable":[]}},"response":[],"_postman_id":"94681304-2ae6-4002-bcdc-8fb2fb810ee2"}],"id":"87de8042-d24c-4ffa-ba98-002745d0b43e","description":"

Tags are the reference keywords or hashtags added to listings. You can associate multiple tags to the listings. Tags are stored as unique keywords.

Sample Object

{\n    \"id\": 53,\n    \"name\": \"Monstera\"\n}\n

Tag Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
`id`	`integer`	unique identifier of the tag
`name`	`string`	name of the tag

","_postman_id":"87de8042-d24c-4ffa-ba98-002745d0b43e"},{"name":"Feeds","item":[{"name":"Home","event":[{"listen":"test","script":{"id":"86314150-e804-46ac-ad3f-4d21fa3f97ee","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a valid JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Response should have 'listings' and 'banners' properties\", function () {"," pm.expect(pm.response.json().hasOwnProperty('listings')).to.be.true;"," pm.expect(pm.response.json().hasOwnProperty('banners')).to.be.true;","});","","pm.test(\"'listings' property should be an array\", function () {"," pm.expect(Array.isArray(pm.response.json().listings)).to.be.true;","});","","pm.test(\"'banners' property should be an array\", function () {"," pm.expect(Array.isArray(pm.response.json().banners)).to.be.true;","});",""],"type":"text/javascript"}}],"id":"6f110212-39df-4782-9030-078011d40b81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/home","urlObject":{"path":["products","v1","home"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f110212-39df-4782-9030-078011d40b81"}],"id":"d5cd12b0-38c8-4514-bf03-9e5313d92b9b","_postman_id":"d5cd12b0-38c8-4514-bf03-9e5313d92b9b","description":""},{"name":"UnBlock Account","event":[{"listen":"test","script":{"id":"5f92ba2c-d980-4fd8-97f8-a7a681298bb3","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"0a2ac191-df29-4b85-8a19-869fcf59ee61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts/{{account_id}}/block","description":"

UnnBlock an account. Upon successful response currently, logged-in user have successfully unblocked the account mentioned in the endpoint.

💡 useful for social commerce

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`account_id`	required	`integer`	unique identifier of the account

","urlObject":{"path":["v1","accounts","{{account_id}}","block"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a2ac191-df29-4b85-8a19-869fcf59ee61"},{"name":"Follow Account","event":[{"listen":"test","script":{"id":"f0a38638-2f31-4fc8-bfa9-159c90219fc6","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should contain 'followed' key with value true\", function () {"," pm.response.to.have.jsonBody('followed', true);","});",""],"type":"text/javascript"}}],"id":"fe038d55-c965-45b8-a47b-deec7b913c7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts/{{account_id}}/follow","description":"

Follow an account. Upon successful response currently logged in user will follow the account mentioned in the endpoint.

💡 useful for social commerce

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`account_id`	required	`integer`	unique identifier of the account

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/accounts/{{account_id}}/follow","description":"

UnFollow an account. Upon successful response currently logged in user will unfollow the account mentioned in the endpoint.

💡 useful for social commerce

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`account_id`	required	`integer`	unique identifier of the account

","urlObject":{"path":["v1","accounts","{{account_id}}","follow"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b1f3654-629a-404f-af48-40b5f2a9f298"},{"name":"UnLike Listing","event":[{"listen":"test","script":{"id":"1b94be66-4cf3-4a2e-89e5-5feeafcbc5ce","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a success message\", function () {"," pm.response.to.be.success;","});","","pm.test(\"Response should be an object\", function () {"," pm.response.to.be.an('object');","});","","pm.test(\"Response should have a success key with value true\", function () {"," pm.expect(pm.response.json().success).to.be.true;","});",""],"type":"text/javascript"}}],"id":"a642a137-a4ee-48c3-bb33-757588b3045d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/app/products/v1/listings/{{listing_id}}/likes","description":"

tags & offer_percent are optional

atleast one image is mandatory

Error Codes

CODE_STORE_NOT_FOUND = 330

CODE_CATEGORY_NOT_FOUND = 331

CODE_MISSING_ATTRIBUTES = 332

CODE_INVALID_ATTRIBUTES = 333

\n","urlObject":{"path":["app","products","v1","listings","{{listing_id}}","likes"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a642a137-a4ee-48c3-bb33-757588b3045d"},{"name":"Like Listing","event":[{"listen":"test","script":{"id":"eef38b9c-dbf3-4314-9e01-cb7eba2f7a31","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a valid JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Response should have the correct structure\", function () {"," pm.expect(pm.response.json().success).to.be.true;"," pm.expect(pm.response.json().data).to.be.an('object');","});",""],"type":"text/javascript"}}],"id":"d1e22276-a266-496c-9791-3f957c556ad7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/listings/{{listing_id}}/likes","description":"

tags & offer_percent are optional

atleast one image is mandatory

Error Codes

CODE_STORE_NOT_FOUND = 330

CODE_CATEGORY_NOT_FOUND = 331

CODE_MISSING_ATTRIBUTES = 332

CODE_INVALID_ATTRIBUTES = 333

\n","urlObject":{"path":["products","v1","listings","{{listing_id}}","likes"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1e22276-a266-496c-9791-3f957c556ad7"},{"name":"Social Feeds : Following","event":[{"listen":"test","script":{"id":"144407cd-1cf3-4e12-9614-1214df02945e","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be in JSON format\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Response should contain a data object\", function () {"," pm.expect(pm.response.json().data).to.be.an('object');","});","","pm.test(\"Response data object should contain a feeds array\", function () {"," pm.expect(pm.response.json().data.feeds).to.be.an('array');","});","","pm.test(\"Response data object should contain a total property\", function () {"," pm.expect(pm.response.json().data.total).to.be.a('number');","});","","pm.test(\"Response data object should contain a per_page property\", function () {"," pm.expect(pm.response.json().data.per_page).to.be.a('number');","});","","pm.test(\"Response data object should contain a current_page property\", function () {"," pm.expect(pm.response.json().data.current_page).to.be.a('number');","});","","pm.test(\"Response data object should contain a last_page property\", function () {"," pm.expect(pm.response.json().data.last_page).to.be.a('number');","});",""],"type":"text/javascript"}}],"id":"9136fc81-54ca-4840-a980-4184e605250f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/feeds/following?type=listings&page={{page}}&per_page={{per_page}}","description":"

page is mandatory starts from 1

type is mandatory. currently supports 'listings'

optional:

per_page default value is 30. Value can be upto 100

\n","urlObject":{"path":["products","v1","feeds","following"],"host":["https://api.tradly.app"],"query":[{"key":"type","value":"listings"},{"key":"page","value":"{{page}}"},{"key":"per_page","value":"{{per_page}}"}],"variable":[]}},"response":[],"_postman_id":"9136fc81-54ca-4840-a980-4184e605250f"}],"id":"d658a4b3-5717-408c-bd8e-9ddb7463adc5","_postman_id":"d658a4b3-5717-408c-bd8e-9ddb7463adc5","description":""},{"name":"Shipping Methods","item":[{"name":"Tenant Shipping Methods","event":[{"listen":"test","script":{"id":"4e9b2ec4-6616-4ffe-b80b-3cd0042e9727","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON\", function () {"," pm.response.to.be.json;","});","","pm.test(\"Shipping methods should be returned\", function () {"," var jsonResponse = pm.response.json();"," pm.expect(jsonResponse.shipping_methods).to.be.an('array');","});",""],"type":"text/javascript"}}],"id":"4eb84d51-733a-4638-9710-99030ded2792","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/tenants/shipping_methods","description":"

List all shipping methods configured for your application.

Response

\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

name	type	description
`id`	`integer`	unique identifier of the shipping method
`name`	`string`	name of the shipping method
`logo_path`	`string`	logo or image URL of the shipping method
`type`	`string`	type of the object being returned
`default`	`boolean`	states whether the shipping method is default or not
`active`	`boolean`	states whether the shipping method is active or not
`order_by`	`integer`	rank of the shipping method

","urlObject":{"path":["v1","tenants","shipping_methods"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"4eb84d51-733a-4638-9710-99030ded2792"}],"id":"d0ca034b-2288-4ee2-a995-916ee3ffd8be","description":"

List all shipping methods of your application. You can manage your shipping methods from superadmin by going to Settings > Shipping Method.

To learn more about shipping methods click here

{\n                \"id\": 4,\n                \"name\": \"Pick Up\",\n                \"logo_path\": \"\",\n                \"type\": \"pickup\",\n                \"default\": true,\n                \"active\": true,\n                \"order_by\": 1\n            } \n\n

","event":[{"listen":"prerequest","script":{"id":"c9575c0b-70ce-4caf-bc90-9d781ad0fc48","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a4f87022-6b80-4028-a95b-9026b969a336","type":"text/javascript","exec":[""]}}],"_postman_id":"d0ca034b-2288-4ee2-a995-916ee3ffd8be"},{"name":"Payments","item":[{"name":"Payment Methods","item":[{"name":"Payment Methods","event":[{"listen":"test","script":{"id":"b87da18a-060e-4bd1-9b54-a1f1c6dec433","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response should be a JSON\", function () {"," pm.response.to.have.header(\"Content-Type\", \"application/json; charset=utf-8\");","});","","pm.test(\"Response should not be empty\", function () {"," pm.expect(pm.response.text()).to.not.be.empty;","});","","pm.test(\"Response should contain an array of payment methods\", function () {"," var paymentMethods = pm.response.json();"," pm.expect(Array.isArray(paymentMethods)).to.be.true;","});",""],"type":"text/javascript"}}],"id":"b10294e0-6d62-46ce-b975-eda5328a191f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/tenants/payment_methods","description":"

List all payment methods configured for your application.

Response

\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

name	type	description
`id`	`integer`	unique identifier of the payment method
`name`	`string`	name of the payment method
`logo_path`	`string`	logo or image URL of the payment method
`max_amount`	`float`	maximum amount allowed to checkout with this payment method
`min_amount`	`float`	minimum amount needed to checkout with this payment method
`type`	`string`	type of the object being returned
`default`	`boolean`	states whether the payment method is default or not
`active`	`boolean`	states whether the payment method is active or not
`order_by`	`integer`	rank of the payment method

","urlObject":{"path":["v1","tenants","payment_methods"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b10294e0-6d62-46ce-b975-eda5328a191f"}],"id":"0f35ac79-48d0-4225-a4fa-83fb60ca2f54","description":"

List all payment methods of your application. You can manage your payment methods from superadmin by going to Settings > Payment Method.

To learn more about payment methods click here

{\n                \"id\": 3,\n                \"name\": \"Stripe\",\n                \"logo_path\": \"\",\n                \"max_amount\": 100000,\n                \"min_amount\": 2,\n                \"type\": \"stripe\",\n                \"channel\": \"sdk\",\n                \"default\": true,\n                \"order_by\": 1,\n                \"active\": true\n            }  \n\n

","_postman_id":"0f35ac79-48d0-4225-a4fa-83fb60ca2f54"},{"name":"Stripe","item":[{"name":"Ephemeral Key","id":"1fbea5f5-a750-4690-ada0-eab284675e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"},{"key":"x-currency","type":"text","value":"inr"}],"body":{"mode":"raw","raw":"{\n \"api_version\": \"2019-09-09\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/app/v1/payments/stripe/ephemeralKey","description":"

name & phone_number are mandatory for type SHIPPING

landmark is optional

// Address Type

ADDRESS_STORE = 1

ADDRESS_SHIPPING = 2

\n","urlObject":{"path":["app","v1","payments","stripe","ephemeralKey"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fbea5f5-a750-4690-ada0-eab284675e4e"},{"name":"Payment Intent","id":"61fa4a7d-1ba8-40d3-a7be-b42010cc5c2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"},{"key":"x-currency","value":"USD","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_reference\": \"9761282\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/app/v1/payments/stripe/paymentIntent","description":"

name & phone_number are mandatory for type SHIPPING

landmark is optional

// Address Type

ADDRESS_STORE = 1

ADDRESS_SHIPPING = 2

\n","urlObject":{"path":["app","v1","payments","stripe","paymentIntent"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"61fa4a7d-1ba8-40d3-a7be-b42010cc5c2c"},{"name":"Connect OAuth","id":"a6179c08-67cf-455f-8ac2-70a4d15a1b4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/payments/stripe/connect/oauth","urlObject":{"path":["v1","payments","stripe","connect","oauth"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6179c08-67cf-455f-8ac2-70a4d15a1b4e"},{"name":"Disconnect OAuth","id":"c14f1006-ed20-4f04-a8f6-5bf9a5918c26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/payments/stripe/connect/oauth","urlObject":{"path":["v1","payments","stripe","connect","oauth"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"c14f1006-ed20-4f04-a8f6-5bf9a5918c26"},{"name":"Create Account Links","id":"b16d6b61-543b-4681-96fc-b8c8936e838b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"},{"key":"x-currency","type":"text","value":"inr"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 50\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/app/v1/payments/stripe/connect/account_links","urlObject":{"path":["app","v1","payments","stripe","connect","account_links"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b16d6b61-543b-4681-96fc-b8c8936e838b"},{"name":"Create Express Login Link","id":"66da2347-5b2b-4228-b697-89987822b695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"},{"key":"x-currency","type":"text","value":"inr"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 37\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/app/v1/payments/stripe/connect/login_links","urlObject":{"path":["app","v1","payments","stripe","connect","login_links"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"66da2347-5b2b-4228-b697-89987822b695"},{"name":"Stripe Connect Account","id":"a16fa0a2-1cc3-4621-8640-a751878eeecf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/payments/stripe/connect/account?account_id={{account_id}}","urlObject":{"path":["v1","payments","stripe","connect","account"],"host":["https://api.tradly.app"],"query":[{"key":"account_id","value":"{{account_id}}"}],"variable":[]}},"response":[],"_postman_id":"a16fa0a2-1cc3-4621-8640-a751878eeecf"},{"name":"Stripe Produts","id":"d5672a76-9848-4737-9fe4-ad9a266f61ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/payments/stripe/products","urlObject":{"path":["v1","payments","stripe","products"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5672a76-9848-4737-9fe4-ad9a266f61ab"}],"id":"4e59c023-08c2-4a59-a79f-39e041db3edc","_postman_id":"4e59c023-08c2-4a59-a79f-39e041db3edc","description":""},{"name":"PayU Latam","item":[{"name":"Payment Intent","id":"c5b921ba-8c1c-450f-be90-59a75087174a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"},{"key":"x-currency","value":"inr","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_reference\": \"096e3b35-7902-43fe-a11a-c9a47de4f273\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/app/v1/payments/payulatam/paymentIntent","description":"

name & phone_number are mandatory for type SHIPPING

landmark is optional

// Address Type

ADDRESS_STORE = 1

ADDRESS_SHIPPING = 2

\n","urlObject":{"path":["app","v1","payments","payulatam","paymentIntent"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5b921ba-8c1c-450f-be90-59a75087174a"}],"id":"ffe73286-3bac-4935-acdc-5d47c9902e51","_postman_id":"ffe73286-3bac-4935-acdc-5d47c9902e51","description":""}],"id":"27f8339c-abf8-482f-b520-22e477f59c93","_postman_id":"27f8339c-abf8-482f-b520-22e477f59c93","description":""},{"name":"Checkout","item":[{"name":"Cart","item":[{"name":"Add To Cart","event":[{"listen":"test","script":{"id":"43bef1d3-1e72-4545-970b-568690cd17ee","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(201);","});","","pm.test(\"Response should contain listing object\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property(\"listing\");","});","","pm.test(\"Listing object should have required properties\", function () {"," var jsonData = pm.response.json();"," var listing = jsonData.listing;"," pm.expect(listing).to.have.property(\"id\");"," pm.expect(listing).to.have.property(\"title\");"," pm.expect(listing).to.have.property(\"description\");"," pm.expect(listing).to.have.property(\"category_id\");"," pm.expect(listing).to.have.property(\"images\");"," pm.expect(listing).to.have.property(\"list_price\");"," pm.expect(listing).to.have.property(\"offer_percent\");"," pm.expect(listing).to.have.property(\"tags\");"," pm.expect(listing).to.have.property(\"attributes\");","});",""],"type":"text/javascript"}}],"id":"77f2ae12-eca8-464b-8a43-db4dbdb8c5f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"},{"key":"X-Currency","value":"USD","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"listing_id\": 124578,\n \"variant_id\": 137112,\n \"quantity\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/cart","urlObject":{"path":["products","v1","cart"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"77f2ae12-eca8-464b-8a43-db4dbdb8c5f9"},{"name":"Delete from Cart","event":[{"listen":"test","script":{"id":"c99a3b0b-2879-4fd9-9302-04fe381ad4c1","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response body is correct\", function () {"," pm.expect(pm.response.text()).to.include(\"listing\");","});","","pm.test(\"Tenant key is correct\", function () {"," pm.expect(request.headers.get(\"tenant_key\")).to.equal(\"ff9294e1f1ac6c12361b4516c5e155d0\");","});","","pm.test(\"Auth key is correct\", function () {"," pm.expect(request.headers.get(\"auth_key\")).to.equal(\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODQ3MjI3NjcsImRhdGEiOiJmZmM4NDNlOWEyZmQ0MjAxZmZmMGY0YmZmZDBhNjZlNTI2Y2IyMDE2MGI3NDEyNDk5MmQxZjIzMWRjY2VlMTk1YmE2Y2UzNmVjNTVhYmQwNjgyZWNmNmEwMTI0YTEzMjNhNTZmMDM5Zjg2",""],"type":"text/javascript"}}],"id":"5f0e4ca1-cc38-439c-a10f-b8515ebe82d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"listing_id\": [134569]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/cart","urlObject":{"path":["products","v1","cart"],"host":["https://api.tradly.app"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"5f0e4ca1-cc38-439c-a10f-b8515ebe82d2"},{"name":"Get Cart","id":"1366e858-68ae-4417-bd0a-a4cdd6a82250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"},{"key":"X-Currency","value":"USD","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/cart?shipping_method_id={{shipping_method_id}}","urlObject":{"path":["products","v1","cart"],"host":["https://api.tradly.app"],"query":[{"key":"shipping_method_id","value":"{{shipping_method_id}}"}],"variable":[]}},"response":[],"_postman_id":"1366e858-68ae-4417-bd0a-a4cdd6a82250"},{"name":"Checkout","id":"f9742f25-bec0-445f-b6b4-880aace64492","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"payment_method_id\": 13,\n \"shipping_method_id\": 12,\n \"shipping_address_id\": 1681\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/cart/checkout","urlObject":{"path":["products","v1","cart","checkout"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9742f25-bec0-445f-b6b4-880aace64492"},{"name":"Delete all cart details","id":"14ebc7f8-eb68-4698-a0ea-7f90d728fdaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/cart","urlObject":{"path":["products","v1","cart"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"14ebc7f8-eb68-4698-a0ea-7f90d728fdaf"}],"id":"c393ebd6-aaa3-428d-955e-b2030b234878","_postman_id":"c393ebd6-aaa3-428d-955e-b2030b234878","description":""},{"name":"Orders","item":[{"name":"Shipments","item":[{"name":"Update Shipment Status","id":"7c222b2a-d566-4b39-8e0a-60460b6d8109","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"shipment\": {\n \"status\": 6\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/orders/{{order_id}}/shipments/{{shipment_id}}/status","description":"

Update shipment status.

`status` is the status of the shipment to be changed. This status value should be one of the values from next_status array from the shipment object.

\n","urlObject":{"path":["products","v1","orders","{{order_id}}","shipments","{{shipment_id}}","status"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c222b2a-d566-4b39-8e0a-60460b6d8109"}],"id":"b60ddfd2-2248-4b53-a803-f4928311b7fb","description":"

An order can have multiple shipments. Below is the list of the status of the shipment,

\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

shipment status	description
`1`	Created
`2`	In progress
`3`	Shipped
`4`	Ready for pickup
`5`	Out for delivery
`6`	Undelivered returned
`7`	Delivered
`8`	Delivery Confirmed
`9`	Customer Initiated Return
`10`	Customer Return Picked
`11`	Customer Return Confirmed
`12`	Cancelled by Account
`13`	Cancelled by Customer
`14`	Arrived at Location
`15`	Cancelled by Admin

","_postman_id":"b60ddfd2-2248-4b53-a803-f4928311b7fb"},{"name":"Orders","id":"c18e3d39-06e3-4d2e-997e-bf866604e69b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text","description":"

user's auth key received from login/register response

\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.tradly.app/products/v1/orders?page={{page}}&type={{type}}&account_id={{account_id}}&order_status={{order_status}}","description":"

Get orders list.

\n","urlObject":{"path":["products","v1","orders"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

REQUIRED. pagination starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

OPTIONAL. type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"},{"description":{"content":"

OPTIONAL. account identifier to filter order by account

\n","type":"text/plain"},"key":"account_id","value":"{{account_id}}"},{"description":{"content":"

OPTIONAL. comma separated order statuses to filter by status of the order

\n","type":"text/plain"},"key":"order_status","value":"{{order_status}}"}],"variable":[]}},"response":[],"_postman_id":"c18e3d39-06e3-4d2e-997e-bf866604e69b"},{"name":"Update Order Status","id":"fc665620-3f3e-4469-80a6-1732b3157d1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"status\": 6\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/orders/{{order_id}}/status","description":"

Update order status.

`status` is the status of the order to be changed. This status value should be one of the values from next_status array from the order object.

\n","urlObject":{"path":["products","v1","orders","{{order_id}}","status"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc665620-3f3e-4469-80a6-1732b3157d1e"},{"name":"Order Details","id":"c5e6a03e-a349-4a3b-8ac4-cb4b459d4c3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"url":"https://api.tradly.app/products/v1/orders/{{order_id}}","description":"

Get order summary.

\n","urlObject":{"path":["products","v1","orders","{{order_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5e6a03e-a349-4a3b-8ac4-cb4b459d4c3a"},{"name":"Confirm Order","id":"40a8001d-b1ab-4472-bf9b-07b752dab5a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"payment_info\": {\n \"key\": \"value\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/products/v1/orders/{{order_id}}/confirm","description":"

Confirm orders with payment status as PAID

optionally payment_info can be sent to store your payment information as JSON.

\n","urlObject":{"path":["products","v1","orders","{{order_id}}","confirm"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"40a8001d-b1ab-4472-bf9b-07b752dab5a9"}],"id":"29e3e7b5-c041-44b6-9e00-df6e8dd42f80","description":"

\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

order status	description
`1`	Incomplete
`2`	Confirmed
`3`	In progress
`4`	Shipped
`5`	Delivered
`6`	Canceled by customer
`7`	Canceled by admin
`8`	Completed

","event":[{"listen":"prerequest","script":{"id":"2e588fee-5d08-4b4f-a6e4-7ff4980f9206","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"28647f33-56fe-4e5a-82c2-35c189b4209f","type":"text/javascript","exec":[""]}}],"_postman_id":"29e3e7b5-c041-44b6-9e00-df6e8dd42f80"},{"name":"Transactions","item":[{"name":"Transactions","id":"2b237002-c8b2-45d7-9f3d-2c517a5793d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"}],"url":"https://api.tradly.app/v1/transactions?page={{page}}&per_page={{per_page}}&account_id={{account_id}}","description":"

query params

===============

super_type = 1 - tenant 2 - seller

account_id = account's id

page = pagination starts from 1

start_date

end_date

\n","urlObject":{"path":["v1","transactions"],"host":["https://api.tradly.app"],"query":[{"key":"page","value":"{{page}}"},{"key":"per_page","value":"{{per_page}}"},{"key":"account_id","value":"{{account_id}}"}],"variable":[]}},"response":[],"_postman_id":"2b237002-c8b2-45d7-9f3d-2c517a5793d5"},{"name":"Earnings","id":"77aecc38-886d-498e-8cde-a87f59ca2dd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"x-auth-key","type":"text","value":"{{x_auth_key}}"}],"url":"https://api.tradly.app/v1/earnings?account_id={{account_id}}","description":"

query params

===============

super_type = 1 - tenant 2 - seller

account_id = account's id

page = pagination starts from 1

start_date

end_date

\n","urlObject":{"path":["v1","earnings"],"host":["https://api.tradly.app"],"query":[{"key":"account_id","value":"{{account_id}}"}],"variable":[]}},"response":[],"_postman_id":"77aecc38-886d-498e-8cde-a87f59ca2dd4"}],"id":"12c4f8a6-4b0c-4a8c-b4c9-74b6718ca37e","_postman_id":"12c4f8a6-4b0c-4a8c-b4c9-74b6718ca37e","description":""}],"id":"bffea149-477e-4686-91c9-a6f05439dac2","_postman_id":"bffea149-477e-4686-91c9-a6f05439dac2","description":""},{"name":"Commissions","item":[{"name":"Commission List","id":"64f5c1df-5736-4678-8116-f94d9ccf6cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"commission\": {\n\t\t\"title\": \"commission 3\",\n\t\t\"type\": \"supply\",\n\t\t\"default_value\": 10,\n\t\t\"active\" : true,\n\t\t\"commission_data\": [\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t243\n\t\t\t\t],\n\t\t\t\t\"type\": 1,\n\t\t\t\t\"fixed_value\": 18.5\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t244\n\t\t\t\t],\n\t\t\t\t\"type\": 2,\n\t\t\t\t\"slab_value\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 1,\n\t\t\t\t\t\t\"to\": 101,\n\t\t\t\t\t\t\"value\": 25\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 102,\n\t\t\t\t\t\t\"to\": 130,\n\t\t\t\t\t\t\"value\": 20\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 151,\n\t\t\t\t\t\t\"to\": -1,\n\t\t\t\t\t\t\"value\": 20\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/commissions?type=supply","urlObject":{"path":["v1","commissions"],"host":["{{base_url_local}}"],"query":[{"key":"type","value":"supply"}],"variable":[]}},"response":[],"_postman_id":"64f5c1df-5736-4678-8116-f94d9ccf6cb0"},{"name":"Commission Detail","id":"148755f3-9c30-4c39-9e28-e7d7a73388bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"commission\": {\n\t\t\"title\": \"commission 3\",\n\t\t\"type\": \"supply\",\n\t\t\"default_value\": 10,\n\t\t\"active\" : true,\n\t\t\"commission_data\": [\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t243\n\t\t\t\t],\n\t\t\t\t\"type\": 1,\n\t\t\t\t\"fixed_value\": 18.5\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t244\n\t\t\t\t],\n\t\t\t\t\"type\": 2,\n\t\t\t\t\"slab_value\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 1,\n\t\t\t\t\t\t\"to\": 101,\n\t\t\t\t\t\t\"value\": 25\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 102,\n\t\t\t\t\t\t\"to\": 130,\n\t\t\t\t\t\t\"value\": 20\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 151,\n\t\t\t\t\t\t\"to\": -1,\n\t\t\t\t\t\t\"value\": 20\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/commissions/2","urlObject":{"path":["v1","commissions","2"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"148755f3-9c30-4c39-9e28-e7d7a73388bc"},{"name":"Add Commissions","id":"87a20f6b-8575-4a8d-ba96-13ad75b2c129","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"commission\": {\n\t\t\"title\": \"commission 4\",\n\t\t\"type\": \"supply\",\n\t\t\"default_value\": 10,\n\t\t\"active\" : true,\n\t\t\"commission_data\": [\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t243 \n\t\t\t\t],\n\t\t\t\t\"type\": 1,\n\t\t\t\t\"fixed_value\": 18.5\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t244\t\n\t\t\t\t],\n\t\t\t\t\"type\": 2,\n\t\t\t\t\"slab_value\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 1,\n\t\t\t\t\t\t\"to\": -1,\n\t\t\t\t\t\t\"value\": 25\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/commissions","urlObject":{"path":["v1","commissions"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"87a20f6b-8575-4a8d-ba96-13ad75b2c129"},{"name":"Edit Commissions","id":"00cd8a57-ec3e-46b6-85f5-e257c94b64b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"commission\": {\n\t\t\"title\": \"commission 5\",\n\t\t\"type\": \"supply\",\n\t\t\"default_value\": 15,\n\t\t\"active\" : false,\n\t\t\"commission_data\": [\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t243\n\t\t\t\t],\n\t\t\t\t\"type\": 1,\n\t\t\t\t\"fixed_value\": 18.9\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"category\": [\n\t\t\t\t\t244\n\t\t\t\t],\n\t\t\t\t\"type\": 2,\n\t\t\t\t\"slab_value\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 1,\n\t\t\t\t\t\t\"to\": 100,\n\t\t\t\t\t\t\"value\": 25\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 102,\n\t\t\t\t\t\t\"to\": 130,\n\t\t\t\t\t\t\"value\": 15\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"from\": 151,\n\t\t\t\t\t\t\"to\": -1,\n\t\t\t\t\t\t\"value\": 20\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/commissions/3","urlObject":{"path":["v1","commissions","3"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00cd8a57-ec3e-46b6-85f5-e257c94b64b3"},{"name":"Delete Commissions","id":"b2bca8e3-010a-4c0d-91de-add391b904e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/commissions/3","urlObject":{"path":["v1","commissions","3"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2bca8e3-010a-4c0d-91de-add391b904e2"},{"name":"Calculate Commissions","id":"4909338d-7173-429a-a8ea-76bb7925de0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"listings\",\n \"account_id\" : 1,\n \"category_id\" : [244, 243],\n \"list_price\" : 2000\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/commissions/calculate","urlObject":{"path":["v1","commissions","calculate"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4909338d-7173-429a-a8ea-76bb7925de0e"}],"id":"9eb709f4-8369-4fbc-baf5-a2d4d4c8c8f4","description":"

Commissions let you to monetize from your sellers on the marketplace you build.

\n","_postman_id":"9eb709f4-8369-4fbc-baf5-a2d4d4c8c8f4"},{"name":"Commons","item":[{"name":"Categories","item":[{"name":"Categories List","id":"395d800f-30e4-43a4-a3da-0b729ad21d9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/categories?parent={{parent_id}}&type={{type}}","description":"

Get category list.

\n","urlObject":{"path":["v1","categories"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

parent id of the category. pass 0 to get top level categroies

\n","type":"text/plain"},"key":"parent","value":"{{parent_id}}"},{"description":{"content":"

type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"395d800f-30e4-43a4-a3da-0b729ad21d9c"},{"name":"Category Detail","id":"c10c25f0-8dc0-4b87-9a6f-17540b9581b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/categories/{{category_id}}?type={{type}}","description":"

Get category detail.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`category_id`	required	`integer`	unique id of the category

","urlObject":{"path":["v1","categories","{{category_id}}"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"c10c25f0-8dc0-4b87-9a6f-17540b9581b6"},{"name":"Add Category","event":[{"listen":"test","script":{"id":"3cafff4b-f857-43c2-b50b-af1006025611","exec":["pm.test(\"Set category_id variable\", function () {"," // Get the response body"," var body = pm.response.json();",""," // Set the category_id variable to the id field in the response body, if it exists"," var id = body.category && body.category.id;"," pm.variables.set(\"category_id\", id);",""," // Assert that the category_id variable has been set"," pm.expect(pm.variables.has(\"category_id\")).to.be.true;","});",""],"type":"text/javascript"}}],"id":"86557b6c-fe97-44ba-81d6-9bf1e56eb834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"category\": {\n \"name\": \"Sports\",\n \"image_path\": \"https://storage.cloud.google.com/tradlyapp/assets/category_images/table_tennis.png\",\n \"parent\": 0,\n \"active\": true,\n \"order_by\": 1,\n \"type\": \"listings\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/categories","description":"

[ADMIN]

\n \n

Adds a new category.

Request:

\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

name	required	type	description
`name`	required	`string`	name of the category
`image_path`	optional	`string`	image URL. shouldn't be empty
`parent`	required	`integer`	parent id of the category. pass 0 for top level categories
`active`	required	`boolean`	states whether this category is active or not
`order_by`	optional	`integer`	rank of the category
`type`	required	`string`	type of the object being returned

","urlObject":{"path":["v1","categories"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"86557b6c-fe97-44ba-81d6-9bf1e56eb834"},{"name":"Edit Category","event":[{"listen":"test","script":{"id":"3d7fb1af-773f-4ab9-a269-b8e9e60c9a9a","exec":["// Set the baseURL variable to the hostname of the API","pm.variables.set('baseURL', 'https://api.tradly.app');","","// Set the requestURL variable to the full URL of the request","pm.variables.set('requestURL', `{{baseURL}}/v1/categories/{{category_id}}`);","","// Set the authKey variable to the x-auth-key header value","pm.variables.set('authKey', '{{x-auth-key}}');","","// Set the request method to PUT","pm.variables.set('requestMethod', 'PUT');","","// Set the request headers","pm.variables.set('requestHeaders', {"," 'Content-Type': 'application/json',"," 'x-auth-key': '{{authKey}}'","});","","// Set the request body","pm.variables.set('requestBody', {"," \"category\": {"," \"name\": \"Sports\","," \"image_path\": \"https://storage.cloud.google.com/tradlyapp/assets/category_images/table_tennis.png\","," \"parent\": 229,"," \"active\": false,"," \"order_by\": 10,"," \"type\": \"listings\""," }","});","","// Send the request","pm.sendRequest({"," url: '{{requestURL}}',"," method: '{{requestMethod}}',"," headers: '{{requestHeaders}}',"," body: '{{requestBody}}'","}, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Set the category_id variable to the returned id in the response"," pm.environment.set('category_id', res.json().category.id);","});",""],"type":"text/javascript"}}],"id":"6af1c3f4-badd-45e4-a9b5-7c5a29feccd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-auth-key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"category\": {\n \"name\": \"Sports\",\n \"image_path\": \"https://storage.cloud.google.com/tradlyapp/assets/category_images/table_tennis.png\",\n \"parent\": 229,\n \"active\": false,\n \"order_by\": 10,\n \"type\": \"listings\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/categories/{{category_id}}","description":"

[ADMIN]

\n \n

Edit existing category.

Request:

\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

name	required	type	description
`name`	required	`string`	name of the category
`image_path`	optional	`string`	image URL. shouldn't be empty
`parent`	required	`integer`	parent id of the category. pass 0 for top level categories
`active`	required	`boolean`	states whether this category is active or not
`order_by`	optional	`integer`	rank of the category
`type`	required	`string`	type of the object being returned

","urlObject":{"path":["v1","categories","{{category_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6af1c3f4-badd-45e4-a9b5-7c5a29feccd6"},{"name":"Edit Category [BULK]","id":"ef114d58-8c93-4d7c-b8da-71a5ab754940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-auth-key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"categories\": [\n {\n \"id\": 189,\n \"name\": \"Sports\",\n \"image_path\": \"https://storage.cloud.google.com/tradlyapp/assets/category_images/table_tennis.png\",\n \"parent\": 0,\n \"active\": false,\n \"order_by\": 1,\n \"type\": \"listings\"\n },\n {\n \"id\": 190,\n \"name\": \"Arts\",\n \"image_path\": \"https://storage.cloud.google.com/tradlyapp/assets/category_images/arts.png\",\n \"parent\": 0,\n \"active\": true,\n \"order_by\": 2,\n \"type\": \"listings\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/categories/bulk","description":"

[ADMIN]

\n\n

Bulk update existing categories. send an array of categories in the request to update.

Request:

\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

name	required	type	description
`name`	required	`string`	name of the category
`image_path`	optional	`string`	image URL. shouldn't be empty
`parent`	required	`integer`	parent id of the category. pass 0 for top level categories
`active`	required	`boolean`	states whether this category is active or not
`order_by`	optional	`integer`	rank of the category
`type`	required	`string`	type of the object being returned

","urlObject":{"path":["v1","categories","bulk"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef114d58-8c93-4d7c-b8da-71a5ab754940"},{"name":"Delete Category","event":[{"listen":"test","script":{"id":"ce277bf2-ebd9-4fd0-b0bd-edcc0e1b99ea","exec":["pm.test(\"Delete category\", function () {"," // Send the DELETE request"," pm.sendRequest({"," url: 'https://api.tradly.app/v1/categories/{{category_id}}',"," method: 'DELETE',"," header: {"," 'Content-Type': 'application/json',"," 'X-Auth-Key': '{{x-auth-key}}'"," },"," data: ''"," }, function (response) {"," // Check that the response has a status code of 200"," pm.response.to.have.status(200);",""," // Check that the response has a success status"," pm.expect(response.json().status).to.be.true;"," });","});",""],"type":"text/javascript"}}],"id":"96e4c445-e096-49df-917c-cf0b9308e077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"x-auth-key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/categories/{{category_id}}","description":"

[ADMIN]

\n \n

Delete existing category.

\n","urlObject":{"path":["v1","categories","{{category_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"96e4c445-e096-49df-917c-cf0b9308e077"}],"id":"f7f9e9ab-99fe-4459-8578-4b8d1312d0a4","description":"

Manage and get categories.

Object

 {\n                \"id\": 12,\n                \"parent\": 0,\n                \"type\": \"listings\",\n                \"active\": true,\n                \"image_path\": \"https://storage.googleapis.com/tradlyapp/assets/category_images/sandbox/table_tennis.png\",\n                \"order_by\": 1,\n                \"sub_category\": [],\n                \"name\": \"Sports\",\n                \"hierarchy\": [\n                    {\n                        \"id\": 12,\n                        \"name\": \"Sports\",\n                        \"level\": 1\n                    }\n                ]\n            }\n

Category Object

\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

name	type	description
`id`	`integer`	unique id of the category
`name`	`string`	name of the category
`image_path`	`string`	image URL. shouldn't be empty
`parent`	`integer`	parent id of the category. pass 0 for top-level categories
`active`	`boolean`	states whether this category is active or not
`order_by`	`integer`	rank of the category
`type`	`string`	type of the object being returned
`sub_category`	`array`	subcategories of the current category. It will be empty when there are no subcategories
`hierarchy`	`array`	this will provide you the hierarchy level information of the current category. for more information see hierarchy object

Hierarchy Object

\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

name	type	description
`id`	`integer`	unique id of the category
`name`	`string`	name of the category
`level`	`string`	hierarchy level. always starts from 1

","_postman_id":"f7f9e9ab-99fe-4459-8578-4b8d1312d0a4"},{"name":"Attribute Groups","item":[{"name":"Attribute Groups List","id":"69c4da21-8d64-44d1-921f-f1e570a5f1b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attribute_groups?type={{type}}","description":"

Get attribute list.

\n","urlObject":{"path":["v1","attribute_groups"],"host":["https://api.tradly.app"],"query":[{"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"69c4da21-8d64-44d1-921f-f1e570a5f1b5"},{"name":"Attribute Group Detail","id":"7eb55703-ec56-4d6c-b7d6-e033395125c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"url":"https://api.tradly.app/v1/attribute_groups/{{attribute_group_id}}","description":"

Get attribute detail.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute

","urlObject":{"path":["v1","attribute_groups","{{attribute_group_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"7eb55703-ec56-4d6c-b7d6-e033395125c5"},{"name":"Add Attribute Group","id":"b7df8b2f-5a64-4c5e-8938-dc3c71c8be34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"attribute_group\": {\n \"id\": 1,\n \"name\": \"Contact Information\",\n \"active\": true,\n \"icon_path\": \"\",\n \"order_by\": 1,\n \"type\": \"listings\",\n \"created_at\": 1696680265,\n \"updated_at\": 1696680265\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attribute_groups","description":"

[ADMIN]

\n\n

Adds a new attribute.

Request:

\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

name	type	description
`name`	`string`	name of the attribute
`field_type`	`integer`	field type of the attribute. refer to field type legend here
`optional`	`boolean`	states whether this attribute is optional or not
`active`	`boolean`	states whether this attribute is active or not
`private`	`boolean`	states whether this attribute is private or not. private attributes are visible only to admins
`show_in_filter`	`boolean`	states whether this attribute is shown in filter list or not
`type`	`string`	type of the object being returned
`category_id`	`array`	categories to be mapped to this attribute. array of category ids

","urlObject":{"path":["v1","attribute_groups"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7df8b2f-5a64-4c5e-8938-dc3c71c8be34"},{"name":"Edit Attribute Group","id":"f7908da2-d2e6-463d-9aed-6a352043b212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"attribute_group\": {\n \"name\": \"Contact Information\",\n \"active\": true,\n \"icon_path\": \"\",\n \"order_by\": 1,\n \"type\": \"listings\",\n \"created_at\": 1696680265,\n \"updated_at\": 1696680265\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attribute_groups/{{attribute_group_id}}","description":"

[ADMIN]

\n\n

Edit existing attribute.

Request:

\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

name	type	description
`name`	`string`	name of the attribute
`field_type`	`integer`	field type of the attribute. refer to field type legend here
`optional`	`boolean`	states whether this attribute is optional or not
`active`	`boolean`	states whether this attribute is active or not
`private`	`boolean`	states whether this attribute is private or not. private attributes are visible only to admins
`show_in_filter`	`boolean`	states whether this attribute is shown in filter list or not
`type`	`string`	type of the object being returned
`category_id`	`array`	categories to be mapped to this attribute. array of category ids

","urlObject":{"path":["v1","attribute_groups","{{attribute_group_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7908da2-d2e6-463d-9aed-6a352043b212"},{"name":"Delete Attribute Group","id":"32484934-3544-4905-855a-e35c0cf027ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attribute_groups/{{attribute_group_id}}","description":"

[ADMIN]

\n \n

Delete existing attribute.

\n","urlObject":{"path":["v1","attribute_groups","{{attribute_group_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"32484934-3544-4905-855a-e35c0cf027ad"}],"id":"17368d7f-817e-44c1-a3e2-1a6db6059299","description":"

Manage and get attribute groups

Sample Object

{\n        \"id\": 1,\n        \"name\": \"Contact Information\",\n        \"active\": true,\n        \"icon_path\": \"\",\n        \"order_by\": 1,\n        \"type\": \"listings\",\n        \"created_at\": 1696680265,\n        \"updated_at\": 1696680265\n    }\n\n

Attribute Object

\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

name	type	description
`id`	`integer`	unique id of the attribute group
`name`	`string`	name of the attribute group
`icon_path`	`string`	icon path of the attribute group
`order_by`	`integer`	order of the attribute group to be returned
`created_at`	`integer`	epoch created at timestamp of attribute group
`updated_at`	`integer`	epoch updated at timestamp of attribute group
`active`	`boolean`	states whether this attribute is active or not
`type`	`string`	type of the object being returned

","_postman_id":"17368d7f-817e-44c1-a3e2-1a6db6059299"},{"name":"Attributes","item":[{"name":"Attributes List","id":"539fda30-1534-4a09-8909-86dd68707b8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","value":"{{x-auth-key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/?category_id={{category_id}}&type={{type}}","description":"

Get attribute list.

\n","urlObject":{"path":["v1","attributes",""],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

filter by category id. for more than one category send it as comma separated

\n","type":"text/plain"},"key":"category_id","value":"{{category_id}}"},{"description":{"content":"

type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"539fda30-1534-4a09-8909-86dd68707b8e"},{"name":"Atrribute Detail","id":"d081de63-c0cc-4408-8337-d757d4c234f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}?type={{type}}","description":"

Get attribute detail.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute

","urlObject":{"path":["v1","attributes","{{attribute_id}}"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"d081de63-c0cc-4408-8337-d757d4c234f9"},{"name":"Attribute List Grouped","id":"72320870-f55b-4d5e-b924-abfbbdeabc2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Auth-Key","value":"{{x_auth_key}}","type":"text","description":"

user's auth key received from login/register response

\n"}],"url":"https://api.tradly.app/v1/attributes/grouped?type={{type}}&category_id={{category_id}}","description":"

Get attribute detail.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute

","urlObject":{"path":["v1","attributes","grouped"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"},{"description":{"content":"

filter by category id. for more than one category send it as comma separated

\n","type":"text/plain"},"key":"category_id","value":"{{category_id}}"}],"variable":[]}},"response":[],"_postman_id":"72320870-f55b-4d5e-b924-abfbbdeabc2c"},{"name":"Add Attribute","id":"a5f8fe43-e352-44de-9842-e818ec9832cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"attribute\": {\n \"name\": \"Capacity\",\n \"field_type\": 1,\n \"optional\": false,\n \"active\": true,\n \"type\": \"listings\",\n \"category_id\": [\n 237\n ],\n \"private\": false,\n \"attribute_group_id\": 2\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes","description":"

[ADMIN]

\n\n

Adds a new attribute.

Request:

\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

name	type	description
`name`	`string`	name of the attribute
`field_type`	`integer`	field type of the attribute. refer to field type legend here
`optional`	`boolean`	states whether this attribute is optional or not
`active`	`boolean`	states whether this attribute is active or not
`private`	`boolean`	states whether this attribute is private or not. private attributes are visible only to admins
`show_in_filter`	`boolean`	states whether this attribute is shown in filter list or not
`type`	`string`	type of the object being returned
`category_id`	`array`	categories to be mapped to this attribute. array of category ids

","urlObject":{"path":["v1","attributes"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5f8fe43-e352-44de-9842-e818ec9832cb"},{"name":"Edit Attribute","id":"a2fea4f8-2f7c-4500-9afa-9e1df9897d49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"attribute\": {\n \"name\": \"Capacity\",\n \"field_type\": 1,\n \"optional\": false,\n \"active\": true,\n \"type\": \"listings\",\n \"category_id\": [\n 262\n ],\n \"private\": true,\n \"attribute_group_id\": 2\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}","description":"

[ADMIN]

\n\n

Edit existing attribute.

Request:

\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

name	type	description
`name`	`string`	name of the attribute
`field_type`	`integer`	field type of the attribute. refer to field type legend here
`optional`	`boolean`	states whether this attribute is optional or not
`active`	`boolean`	states whether this attribute is active or not
`private`	`boolean`	states whether this attribute is private or not. private attributes are visible only to admins
`show_in_filter`	`boolean`	states whether this attribute is shown in filter list or not
`type`	`string`	type of the object being returned
`category_id`	`array`	categories to be mapped to this attribute. array of category ids

","urlObject":{"path":["v1","attributes","{{attribute_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2fea4f8-2f7c-4500-9afa-9e1df9897d49"},{"name":"Edit Attribute [BULK]","id":"29347cf6-9064-4431-8d29-9c5077ae0537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"attributes\": [\n {\n \"id\": 12,\n \"name\": \"Capacity\",\n \"field_type\": 1,\n \"optional\": true,\n \"active\": false,\n \"type\": \"listings\",\n \"private\": false,\n \"category_id\": [\n 122\n ],\n \"attribute_group_id\": 2\n },\n {\n \"id\": 14,\n \"name\": \"Post to quarantine states?\",\n \"field_type\": 2,\n \"optional\": false,\n \"active\": true,\n \"type\": \"listings\",\n \"private\": false,\n \"category_id\": [\n 126\n ],\n \"attribute_group_id\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/bulk","description":"

[ADMIN]

\n\n

Bulk update existing attributes. send an array of attributes in the request to update.

Request:

\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

name	type	description
`name`	`string`	name of the attribute
`field_type`	`integer`	field type of the attribute. refer to field type legend here
`optional`	`boolean`	states whether this attribute is optional or not
`active`	`boolean`	states whether this attribute is active or not
`private`	`boolean`	states whether this attribute is private or not. private attributes are visible only to admins
`show_in_filter`	`boolean`	states whether this attribute is shown in filter list or not
`type`	`string`	type of the object being returned
`category_id`	`array`	categories to be mapped to this attribute. array of category ids

","urlObject":{"path":["v1","attributes","bulk"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"29347cf6-9064-4431-8d29-9c5077ae0537"},{"name":"Delete Attribute","id":"3cc61969-e827-4007-96a1-e01ee734c0d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}","description":"

[ADMIN]

\n \n

Delete existing attribute.

\n","urlObject":{"path":["v1","attributes","{{attribute_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cc61969-e827-4007-96a1-e01ee734c0d1"}],"id":"86de8720-6687-42de-b337-6d89f54f030d","description":"

Manage and get attributes

Field Types

\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

type	description
`1`	Single Select
`2`	Multi Select
`3`	Open Value (Single)
`4`	Open Value (Multiple)
`5`	Attachments

Sample Object

{\n    \"id\": 71,\n    \"type\": \"listings\",\n    \"field_type\": 4,\n    \"optional\": true,\n    \"private\": false,\n    \"show_in_filter\": true,\n    \"active\": true,\n    \"name\": \"Fabric\",\n    \"categories\": [\n        {\n            \"id\": 252,\n            \"parent\": 9,\n            \"type\": \"listings\",\n            \"active\": true,\n            \"image_path\": \"https://cdn2.iconfinder.com/data/icons/shirts-glyph/48/Clothing_Shirts_Artboard_2-512.png\",\n            \"order_by\": 1,\n            \"sub_category\": [],\n            \"name\": \"V-Neck\",\n            \"hierarchy\": [\n                {\n                    \"id\": 252,\n                    \"name\": \"V-Neck\",\n                    \"level\": 3\n                }\n            ]\n        }\n    ]\n}\n\n

Attribute Object

\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

name	type	description
`id`	`integer`	unique id of the attribute
`name`	`string`	name of the attribute
`field_type`	`integer`	field type of the attribute. refer to field type legend here
`optional`	`boolean`	states whether this attribute is optional or not
`private`	`boolean`	states whether this attribute is private or not. private attributes are visible only to admins
`show_in_filter`	`boolean`	states whether this attribute is shown in filter list or not
`active`	`boolean`	states whether this attribute is active or not
`type`	`string`	type of the object being returned
`categories`	`array`	categories mapped to this attribute. refer to category object here

","_postman_id":"86de8720-6687-42de-b337-6d89f54f030d"},{"name":"Attribute Values","item":[{"name":"Attributes Values List","id":"e55753bc-2e17-4148-a177-db789dca1baa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}/values","description":"

Get attribute values list.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute

","urlObject":{"path":["v1","attributes","{{attribute_id}}","values"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"e55753bc-2e17-4148-a177-db789dca1baa"},{"name":"Attribute Values Detail","id":"d7367b23-888d-4c71-bd2e-2d71f83eea03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}/values/{{attribute_value_id}}","description":"

Get attribute values detail.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute
`attribute_value_id`	required	`integer`	unique id of the attribute value

","urlObject":{"path":["v1","attributes","{{attribute_id}}","values","{{attribute_value_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7367b23-888d-4c71-bd2e-2d71f83eea03"},{"name":"Add Attribute Values","id":"56ecff3d-5c8e-4fa6-926a-81c69dc9ae76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"attribute\" : {\n \t\"value\" : {\n \t\t\"name\" : \"6 GB\",\n \t\t\"active\" : true\n \t}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}/values","description":"

[ADMIN]

\n \n

Add attribute values.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
`name`	`string`	name of the attribute value
`active`	`boolean`	states whether this attribute value is active or not

","urlObject":{"path":["v1","attributes","{{attribute_id}}","values"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"56ecff3d-5c8e-4fa6-926a-81c69dc9ae76"},{"name":"Edit Attribute Values","id":"cae0bf90-bbb9-4c27-b323-073136a62234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"attribute\" : {\n \t\"value\" : {\n \t\t\"name\" : \"10 GB\",\n \t\t\"active\" : false\n \t}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}/values/{{attribute_value_id}}","description":"

[ADMIN]

\n \n

Add attribute values.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute
`attribute_value_id`	required	`integer`	unique id of the attribute value

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
`name`	`string`	name of the attribute value
`active`	`boolean`	states whether this attribute value is active or not

","urlObject":{"path":["v1","attributes","{{attribute_id}}","values","{{attribute_value_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"cae0bf90-bbb9-4c27-b323-073136a62234"},{"name":"Delete Attribute Values","id":"6149214c-2252-4c1c-ab36-c2b949c85b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/attributes/{{attribute_id}}/values/{{attribute_value_id}}","description":"

[ADMIN]

\n \n

Delete attribute values.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	description
`attribute_id`	required	`integer`	unique id of the attribute
`attribute_value_id`	required	`integer`	unique id of the attribute value

","urlObject":{"path":["v1","attributes","{{attribute_id}}","values","{{attribute_value_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6149214c-2252-4c1c-ab36-c2b949c85b4a"}],"id":"9eb67eb2-f03d-4d9f-a426-da79febfa009","description":"

Manage attribute values

Sample Object

{\n    \"id\": 171,\n    \"active\": true,\n    \"name\": \"K1\"\n}\n

Attribute Value Object

\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

name	type	description
`id`	`integer`	unique id of the attribute value
`name`	`string`	name of the attribute value
`active`	`boolean`	states whether this attribute value is active or not

","event":[{"listen":"prerequest","script":{"id":"141f7f07-536a-4d3a-9df3-4865fd1264e8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0b81331e-7155-43f7-b59e-00d39e2a0824","type":"text/javascript","exec":[""]}}],"_postman_id":"9eb67eb2-f03d-4d9f-a426-da79febfa009"},{"name":"Collections","item":[{"name":"Get Collections","id":"0cab4382-0ef4-4d33-b1ed-c7f5eab12eb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/collections","urlObject":{"path":["v1","collections"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0cab4382-0ef4-4d33-b1ed-c7f5eab12eb2"},{"name":"Get Collection Detail","id":"f8c42a04-733f-4208-b724-6b653e593157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/collections/1","urlObject":{"path":["v1","collections","1"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8c42a04-733f-4208-b724-6b653e593157"},{"name":"Add Collections","id":"3ffcf7c0-2b2c-40d2-aaee-b55ddfb9ebb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"collection\": {\n\t\t\"title\": \"automatic collection - tags\",\n\t\t\"description\": \"supply\",\n\t\t\"scope_type\": 4,\n \"condition_type\" : 1,\n\t\t\"manual_ids\" : [20, 25, 24],\n \"conditions\" : {\n \"OR\" : {\n \"tags\" : [\"Limon\", \"Pet\", \"coffee\", \"Fashion\"]\n }\n },\n \"medium\" :[1],\n \"active\" : true\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/collections","urlObject":{"path":["v1","collections"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ffcf7c0-2b2c-40d2-aaee-b55ddfb9ebb8"},{"name":"Edit Collection","id":"7f9ec7a6-77f4-40e3-925b-56fa040909db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"collection\": {\n\t\t\"title\": \"collection 3\",\n\t\t\"description\": \"supply\",\n\t\t\"scope_type\": 4,\n \"condtion_type\" : 2,\n\t\t\"manual_ids\" : [52],\n \"medium\" :[1],\n \"start_at\": \"2020-12-10T19:49:13Z\",\n \"end_at\": \"2020-12-27T19:49:15Z\",\n \"active\" : true\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/collections/1","urlObject":{"path":["v1","collections","1"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f9ec7a6-77f4-40e3-925b-56fa040909db"},{"name":"Delete Collection","id":"2e08f6f4-bc33-4118-8b41-f1d8cd43f651","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url_local}}/v1/collections/1","urlObject":{"path":["v1","collections","1"],"host":["{{base_url_local}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e08f6f4-bc33-4118-8b41-f1d8cd43f651"}],"id":"1bb387a2-6328-4174-b542-8deac205ed19","_postman_id":"1bb387a2-6328-4174-b542-8deac205ed19","description":""},{"name":"Reviews","item":[{"name":"Reviews List","id":"ca33135e-e41a-48e0-b273-6e118b5b12c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/reviews?type=accounts&id=12&page={{page}}&has_images=true","urlObject":{"path":["v1","reviews"],"host":["https://api.tradly.app"],"query":[{"key":"type","value":"accounts"},{"key":"id","value":"12"},{"key":"page","value":"{{page}}"},{"key":"has_images","value":"true"}],"variable":[]}},"response":[],"_postman_id":"ca33135e-e41a-48e0-b273-6e118b5b12c9"},{"name":"Add Review","id":"3d34c882-233b-4bd6-bd17-ed2f2dd36f8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"review\": {\n \"type\": \"listings\",\n \"id\": 13482,\n \"title\": \"Some optional title Red\",\n \"content\": \"Some optional desccription XXL L\",\n \"images\": [\n \"https://someimage.jpg\",\n \"https://someimage.png\"\n ],\n \"rating\": 3\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/reviews","urlObject":{"path":["v1","reviews"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d34c882-233b-4bd6-bd17-ed2f2dd36f8b"},{"name":"Like/Unlike Review","id":"a1e71123-a222-442b-8c60-a388263a797c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"review\": {\n \"status\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/reviews/1/like","description":"

status

1 - like

2 - dislike

\n","urlObject":{"path":["v1","reviews","1","like"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1e71123-a222-442b-8c60-a388263a797c"}],"id":"014b3b9a-cd65-4e99-af54-d88452e20145","event":[{"listen":"prerequest","script":{"id":"d28dc455-7067-4302-9eed-61ad1359dfb5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b07a81c9-83ad-405c-9b4f-e77989ad81f4","type":"text/javascript","exec":[""]}}],"_postman_id":"014b3b9a-cd65-4e99-af54-d88452e20145","description":""},{"name":"Promotions","item":[{"name":"Promotions List","event":[{"listen":"test","script":{"id":"6e5b9db5-0517-4482-ae0c-21e9ab19f9ac","exec":["pm.test(\"Get promos\", function () {"," // Send the GET request"," pm.sendRequest({"," url: 'https://api.tradly.app/v1/promos?page={{page}}&type={{type}}',"," method: 'GET',"," headers: {"," 'Content-Type': 'application/json',"," 'X-Auth-Key': '{{x_auth_key}}'"," }"," }, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Assert that the response has a status code of 200"," pm.response.to.have.status(200);"," });","});",""],"type":"text/javascript"}}],"id":"48f16868-5a09-4677-b462-087f9824a3ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/promos?page={{page}}&type={{type}}","description":"

Get the list of promotions.

Query Parameters

\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

name	required	type	description
`page`	required	`integer`	pagination starts from 1
`type`	required	`string`	type of the object being returned
`per_page`	optional	`integer`	number of records per page. between 1 and 100
`medium`	optional	`string`	medium/platform of the promo banner
`placement`	optional	`string`	placement of the promo banner

","urlObject":{"path":["v1","promos"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

REQUIRED. pagination starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

REQUIRED. type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"48f16868-5a09-4677-b462-087f9824a3ea"},{"name":"Promotions Detail","event":[{"listen":"test","script":{"id":"4893442f-2430-4cdf-9a12-9ffb10819a96","exec":["pm.test(\"Test GET promo banner by id\", function () {"," // Set the requestURL variable to the full URL of the request"," pm.variables.set('requestURL', 'https://api.tradly.app/v1/promos/{{promo_banner_id}}');",""," // Set the request headers"," pm.variables.set('requestHeaders', {"," 'Content-Type': 'application/json'"," });",""," // Send the request"," pm.sendRequest({"," url: '{{requestURL}}',"," method: 'GET',"," headers: '{{requestHeaders}}'"," }, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Assert that the response has a status code of 200"," pm.expect(res.code).to.equal(200);"," });","});",""],"type":"text/javascript"}}],"id":"804a26b7-94a8-496a-b95e-c4b857500114","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/promos/{{promo_banner_id}}","description":"

Get promotion details

\n","urlObject":{"path":["v1","promos","{{promo_banner_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"804a26b7-94a8-496a-b95e-c4b857500114"},{"name":"Add Promotion","event":[{"listen":"prerequest","script":{"id":"a666ea21-a5d5-4a8e-a2c3-199f3f33758c","exec":["pm.test(\"Add Promotion\", function () {"," // Set the request method to POST"," pm.variables.set('requestMethod', 'POST');",""," // Set the request headers"," pm.variables.set('requestHeaders', {"," 'Content-Type': 'application/json',"," 'X-Auth-Key': '{{x-auth-key}}'"," });",""," // Set the request body"," pm.variables.set('requestBody', {"," \"promo_banner\": {"," \"reference\": \"first campaign\","," \"image_path\": \"https://storage.googleapis.com/tradlyapp/images/19542/c2d24f03-eef2-436b-a625-c91f734f4bc0.jpg\","," \"medium\": \"app\","," \"type\": \"listing\","," \"value\": \"1\","," \"start_at\": \"2021-05-12\","," \"end_at\": \"2021-06-12\","," \"order_by\": 1,"," \"active\": true"," }"," });",""," // Send the request"," pm.sendRequest({"," url: 'https://api.tradly.app/v1/promos',"," method: '{{requestMethod}}',"," headers: '{{requestHeaders}}',"," body: '{{requestBody}}'"," }, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Set the promo_banner_id variable to the returned id in the response"," pm.environment.set('promo_banner_id', res.json().promo_banner.id);"," });","});",""],"type":"text/javascript"}}],"id":"bcfe44fe-1fbf-4668-bafc-fc707120f6af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"promo_banner\": {\n \t\"reference\" : \"first campaign\",\n \t\"image_path\" : \"https://storage.googleapis.com/tradlyapp/images/19542/c2d24f03-eef2-436b-a625-c91f734f4bc0.jpg\",\n \t\"medium\" : \"app\",\n \t\"type\" : \"listing\",\n \"value\": \"1\",\n \t\"start_at\" : \"2021-05-12\",\n \t\"end_at\" : \"2021-06-12\",\n \t\"order_by\" : 1,\n \t\"active\" : true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/promos","description":"

[ADMIN]

\n\n

Create promotions

Request

\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

name	required	type	description
`reference`	required	`string`	reference name
`image_path`	required	`string`	image URL. shouldn't be empty
`medium`	required	`string`	any medium or platform you want to add. For example you can add one banner for the android app and one banner for web app
`value`	optional	`string`	any optional value. For example you can add a listing id here or deep link that you can use to redirect the user
`start_at`	optional	`date`	YYYY-MM-DD start date of the promo banner. defaults to current date
`end_at`	optional	`date`	YYYY-MM-DD end date of the promo banner. defaults to 30 days from start date
`active`	required	`boolean`	states whether this promo banner is active or not
`order_by`	optional	`optional`	rank of the promo banner. defaults to 1

","urlObject":{"path":["v1","promos"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcfe44fe-1fbf-4668-bafc-fc707120f6af"},{"name":"Edit Promotion","event":[{"listen":"test","script":{"id":"524ec6a0-2ad6-4ee8-98ce-65a32fa05670","exec":["pm.test(\"Test for Edit Promotion\", function () {","// Set the expected response code","pm.response.to.have.status(200);","","// Get the response body","var body = pm.response.json();","","// Assert that the response body has a promo_banner object with an id field","pm.expect(body.promo_banner).to.have.property(\"id\");","","// Set the promo_banner_id variable to the id field in the response body","pm.variables.set(\"promo_banner_id\", body.promo_banner.id);","","// Assert that the promo_banner_id variable has been set","pm.expect(pm.variables.has(\"promo_banner_id\")).to.be.true;","});","","","",""],"type":"text/javascript"}}],"id":"96a7dbec-520d-411c-b0f9-6317c8b560e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

[ADMIN]

\n\n

Edit promotions.

Request

\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

name	required	type	description
`reference`	required	`string`	reference name
`image_path`	required	`string`	image URL. shouldn't be empty
`medium`	required	`string`	any medium or platform you want to add. For example, you can add one banner for the android app and one banner for the web app
`value`	optional	`string`	any optional value. For example, you can add a listing id here or a deep link that you can use to redirect the user
`start_at`	optional	`date`	YYYY-MM-DD start date of the promo banner. defaults to current date
`end_at`	optional	`date`	YYYY-MM-DD end date of the promo banner. defaults to 30 days from start date
`active`	required	`boolean`	states whether this promo banner is active or not
`order_by`	optional	`optional`	rank of the promo banner. defaults to 1

","urlObject":{"path":["v1","promos","{{promo_banner_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"96a7dbec-520d-411c-b0f9-6317c8b560e5"},{"name":"Delete Promotion","event":[{"listen":"test","script":{"id":"d6d8ca97-83a6-4c1c-80de-cafe699b37a6","exec":["pm.test(\"Delete promo banner\", function () {"," // Set the request URL"," pm.variables.set('requestURL', 'https://api.tradly.app/v1/promos/{{promo_banner_id}}');",""," // Set the request method to DELETE"," pm.variables.set('requestMethod', 'DELETE');",""," // Set the request headers"," pm.variables.set('requestHeaders', {"," 'Content-Type': 'application/json',"," 'X-Auth-Key': '{{x-auth-key}}'"," });",""," // Send the request"," pm.sendRequest({"," url: '{{requestURL}}',"," method: '{{requestMethod}}',"," headers: '{{requestHeaders}}',"," body: ''"," }, function (err, res) {"," // Print the response to the console"," console.log(res.json());",""," // Assert that the response has a status code of 200"," pm.expect(res.statusCode).to.be.equal(200);"," });","});",""],"type":"text/javascript"}}],"id":"1c6ca1b6-cf58-4f4b-b1f6-4b47034aee92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/promos/{{promo_banner_id}}","description":"

[ADMIN]

\n \n

Delete promo banners.

Promotions are banners and videos placed in strategic locations to attract attention and promote a particular product, service, or message.

In Tradly, promotions can be directed towards a listing, an account, an external link, or a static message.

To learn more about promotions click here

Object

{\n    \"id\": 12,\n    \"reference\": \"campaign - fresh produce\",\n    \"image_path\": \"https://storage.googleapis.com/tradlyapp/images/19542/c2d24f03-eef2-436b-a625-c91f734f4bc0.jpg\",\n    \"medium\": \"app\",\n    \"type\": \"general\",\n    \"placement\": \"home_top_banner\",\n    \"value\": \"listing id 1\",\n    \"active\": true,\n    \"start_at\": \"2021-01-01\",\n    \"end_at\": \"2021-02-01\"\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

name	type	description
`id`	`integer`	unique identifier of the promo banner
`reference`	`string`	reference name
`image_path`	`string`	image URL. shouldn't be empty
`medium`	`string`	any medium or platform you want to add. For example, you can add one banner for the android app and one banner for the web app
`type`	`string`	type of the object being returned.
`placement`	`string`	optional placement string. example: a banner can be placed at the top of the web page or side of the page
`value`	`string`	any optional value. For example, you can add a listing id here or a deep link that you can use to redirect the user
`start_at`	`date`	YYYY-MM-DD start date of the promo banner
`end_at`	`date`	YYYY-MM-DD end date of the promo banner
`active`	`boolean`	states whether this promo banner is active or not

","_postman_id":"afed06fb-a843-43d3-a350-cab722ef9968"},{"name":"Addresses","item":[{"name":"Addresses List","id":"c577ad4c-2f5d-4d7e-bc74-2a94e887276b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/addresses?type={{type}}","urlObject":{"path":["v1","addresses"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

type of the object being returned

\n","type":"text/plain"},"key":"type","value":"{{type}}"}],"variable":[]}},"response":[],"_postman_id":"c577ad4c-2f5d-4d7e-bc74-2a94e887276b"},{"name":"Add Address","id":"1c25146d-f583-4987-a235-3806c33fba00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"name\": \"John Doe\",\n \"phone_number\": \"77990033\",\n \"address_line_1\": \"13, Building# 81\",\n \"address_line_2\": \"Guerrero St, San Francisco\",\n \"landmark\": \"St. James Catholic Church\",\n \"state\": \"San Francisco\",\n \"post_code\": 94110,\n \"country\": \"United States\",\n \"type\": \"shipping_address\",\n \"coordinates\": {\n \"latitude\": 37.7526906,\n \"longitude\": -122.4241078\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/addresses","description":"

Add an address

\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

name	required	type	description
`name`	required	`string`	name of the contact
`phone_number`	optional	`string`	phone number of the contact
`address_line_1`	required	`string`	address line 1
`address_line_2`	opional	`string`	address line 2
`landmark`	optional	`string`	nearby landmark of the address
`state`	required	`string`	state or province
`post_code`	required	`string`	postal or zip code
`country`	required	`string`	country name
`type`	required	`string`	type of the object being returned.
`coordinates`	optional	`object`	geolocation of the address. refer to coordinates object

","urlObject":{"path":["v1","addresses"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c25146d-f583-4987-a235-3806c33fba00"},{"name":"Edit Address","id":"c3667f11-0fc5-4d51-91f5-4b836135c90f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

Edit an address

\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

name	required	type	description
`name`	required	`string`	name of the contact
`phone_number`	optional	`string`	phone number of the contact
`address_line_1`	required	`string`	address line 1
`address_line_2`	opional	`string`	address line 2
`landmark`	optional	`string`	nearby landmark of the address
`state`	required	`string`	state or province
`post_code`	required	`string`	postal or zip code
`country`	required	`string`	country name
`type`	required	`string`	type of the object being returned
`coordinates`	optional	`object`	geolocation of the address. refer to coordinates object

","urlObject":{"path":["v1","addresses","{{address_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3667f11-0fc5-4d51-91f5-4b836135c90f"},{"name":"Delete Address","id":"bb6294f7-41ef-4b71-8f62-117afac6ee75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/addresses/{{address_id}}","description":"

Delete an address.

\n","urlObject":{"path":["v1","addresses","{{address_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb6294f7-41ef-4b71-8f62-117afac6ee75"}],"id":"ead61278-02a3-4447-b6ce-14642dd9f853","description":"

Manage addresses.

Coordinates Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
`latitude`	`double`	latitude of the geolocation
`longitude`	`double`	longitude of the geolocation

Address Object

{\n    \"id\": 341,\n    \"name\": \"John Doe\",\n    \"phone_number\": \"77990033\",\n    \"address_line_1\": \"13, Building# 81\",\n    \"address_line_2\": \"Guerrero St, San Francisco\",\n    \"landmark\": \"St. James Catholic Church\",\n    \"state\": \"San Francisco\",\n    \"post_code\": 94110,\n    \"country\": \"United States\",\n    \"type\": \"shipping_address\",\n    \"coordinates\": {\n      \"latitude\": 37.7526906,\n      \"longitude\": -122.4241078\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

name	type	description
`id`	`integer`	unique identifier of the address
`name`	`string`	name of the contact
`phone_number`	`string`	phone number of the contact
`address_line_1`	`string`	address line 1
`address_line_2`	`string`	address line 2
`landmark`	`string`	nearby landmark of the address
`state`	`string`	state or province
`post_code`	`string`	postal or zip code
`country`	`string`	country name
`type`	`string`	type of the object being returned
`coordinates`	`object`	geolocation of the address

","_postman_id":"ead61278-02a3-4447-b6ce-14642dd9f853"},{"name":"Activities","item":[{"name":"Activity List","id":"67dc0f3e-725c-4b45-824b-0063def83d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-auth-key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/activities?page={{page}}","urlObject":{"path":["v1","activities"],"host":["https://api.tradly.app"],"query":[{"key":"page","value":"{{page}}"}],"variable":[]}},"response":[],"_postman_id":"67dc0f3e-725c-4b45-824b-0063def83d3c"}],"id":"15b1a28b-2667-4a68-8db9-2bfdf800bbe0","_postman_id":"15b1a28b-2667-4a68-8db9-2bfdf800bbe0","description":""},{"name":"Languages","item":[{"name":"Languages List","id":"5f127e5b-fa4f-4b52-8c04-48f1f82b89b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/tenants/languages","description":"

Get list of all configured languages.

\n","urlObject":{"path":["v1","tenants","languages"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f127e5b-fa4f-4b52-8c04-48f1f82b89b6"}],"id":"6b166f1b-7ab8-4db8-be51-02296890a655","description":"

Languages supported by your application. At least one default language has to be associated with your application. You can manage your languages in the superadmin by going to Settings > Languages.

To learn more about Languages click here.

Object

{\n    \"id\": 1,\n    \"default\": true,\n    \"code\": \"en\",\n    \"name\": \"English\",\n    \"active\": true,\n    \"order_by\": 1\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

name	type	description
`id`	`integer`	unique identifier of the language
`name`	`string`	name of the language
`code`	`string`	locale code of the language
`default`	`boolean`	states whether this language is a default language or not
`active`	`boolean`	states whether this language is active or not
`order_by`	`integer`	rank of the language

","_postman_id":"6b166f1b-7ab8-4db8-be51-02296890a655"},{"name":"Currencies","item":[{"name":"Currencies List","id":"95f630ed-31d2-44b3-aa47-781ff6189d06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/currencies","description":"

Get currencies list.

\n","urlObject":{"path":["v1","currencies"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"95f630ed-31d2-44b3-aa47-781ff6189d06"},{"name":"Currency Detail","id":"4083f8ea-9c5b-4dff-b24d-7659912a4a2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/currencies/{{currency_id}}","description":"

Edit currency.

\n","urlObject":{"path":["v1","currencies","{{currency_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"4083f8ea-9c5b-4dff-b24d-7659912a4a2f"},{"name":"Add Currency","id":"05313063-a0ac-4f7d-9c65-67b2a45a3a9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"currency\": {\n \"name\": \"British Pounds\",\n \"image_path\": \"https://cdn1.iconfinder.com/data/icons/business-finance-1-1/128/currency-sign-pound-512.png\",\n \"code\": \"GBP\",\n \"exchange_rate\": 0.97,\n \"precision\": 2,\n \"thousand_separator\": \",\",\n \"decimal_point\": \".\",\n \"format\": \"£ {amount}\",\n \"default\": false,\n \"active\": true,\n \"order_by\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/currencies","description":"

Add currency.

\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

name	required	type	description
`name`	required	`string`	name of the currency
`image_path`	optional	`string`	logo or image URL of the currency
`code`	required	`string`	3 Letter Alpha-3 code of the currency. For example GBP for British Pounds
`exchange_rate`	optional	`float`	exchange rate against default currency
`precision`	optional	`integer`	range from zero decimals to three decimals
`thousand_separator`	required	`string`	thousands separator of the currency
`decimal_point`	required	`string`	decimal point of the currency
`format`	required	`string`	format of the currency. format must have `{amount}` in the value. For example, to format British Pounds you can enter the value as `£ {amount}`
`default`	required	`boolean`	states whether the currency is default currency or not
`active`	required	`boolean`	states whether the currency is active or not
`order_by`	optional	`integer`	rank of the currency

","urlObject":{"path":["v1","currencies"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"05313063-a0ac-4f7d-9c65-67b2a45a3a9b"},{"name":"Edit Currency","id":"f7d521f6-003c-467e-a15a-c84a6d655ee1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"{\n \"currency\": {\n \"name\": \"British Pounds\",\n \"image_path\": \"https://cdn1.iconfinder.com/data/icons/business-finance-1-1/128/currency-sign-pound-512.png\",\n \"code\": \"GBP\",\n \"exchange_rate\": 0.97,\n \"precision\": 2,\n \"thousand_separator\": \",\",\n \"decimal_point\": \".\",\n \"format\": \"£ {amount}\",\n \"default\": false,\n \"active\": false,\n \"order_by\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/currencies/{{currency_id}}","description":"

Edit currency.

\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

name	required	type	description
`name`	required	`string`	name of the currency
`image_path`	optional	`string`	logo or image URL of the currency
`code`	required	`string`	3 Letter Alpha-3 code of the currency. For example GBP for British Pounds
`exchange_rate`	optional	`float`	exchange rate against default currency
`precision`	optional	`integer`	range from zero decimals to three decimals
`thousand_separator`	required	`string`	thousands separator of the currency
`decimal_point`	required	`string`	decimal point of the currency
`format`	required	`string`	format of the currency. format must have `{amount}` in the value. For example, to format British Pounds you can enter the value as `£ {amount}`
`default`	required	`boolean`	states whether the currency is default currency or not
`active`	required	`boolean`	states whether the currency is active or not
`order_by`	optional	`integer`	rank of the currency

","urlObject":{"path":["v1","currencies","{{currency_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7d521f6-003c-467e-a15a-c84a6d655ee1"},{"name":"Delete Currency","id":"30bc6e9e-e31a-4276-81a4-4f1b107c093c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-Auth-Key","type":"text","value":"{{x-auth-key}}","description":"

user's auth key received from login/register response

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/currencies/{{currency_id}}","description":"

Delete currency.

Manage currencies. You can manage currencies from superadmin as well. To learn more about currencies click here.

Currency Object

{\n    \"id\": 15,\n    \"name\": \"British Pounds\",\n    \"image_path\": \"https://cdn1.iconfinder.com/data/icons/business-finance-1-1/128/currency-sign-pound-512.png\",\n    \"code\": \"GBP\",\n    \"exchange_rate\": 0.97,\n    \"precision\": 2,\n    \"thousand_separator\": \",\",\n    \"decimal_point\": \".\",\n    \"format\": \"£ {amount}\",\n    \"default\": false,\n    \"active\": true,\n    \"order_by\": 1\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

name	type	description
`id`	`integer`	unique identifier of the currency
`name`	`string`	name of the currency
`image_path`	`string`	logo or image URL of the currency
`code`	`string`	3 Letter Alpha-3 code of the currency. For example USD for united states dollars
`exchange_rate`	`float`	exchange rate against default currency
`precision`	`integer`	range from zero decimals to three decimals
`thousand_separator`	`string`	thousands separator of the currency
`decimal_point`	`string`	decimal point of the currency
`format`	`string`	format of the currency. format must have `{amount}` in the value. For example, to format British Pounds you can enter the value as `£ {amount}`
`default`	`boolean`	states whether the currency is default currency or not
`active`	`boolean`	states whether the currency is active or not
`order_by`	`integer`	rank of the currency

","_postman_id":"7f2d20dc-cb93-4305-9e15-c96fc9f00187"},{"name":"Countries","item":[{"name":"Tenant Countries","id":"b16a00d9-ba13-455d-8efb-86b59d0349d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/tenants/countries","urlObject":{"path":["v1","tenants","countries"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b16a00d9-ba13-455d-8efb-86b59d0349d6"}],"id":"1d0059ab-4403-4fd6-a160-eaf5f63eb7d6","_postman_id":"1d0059ab-4403-4fd6-a160-eaf5f63eb7d6","description":""},{"name":"Coupons","item":[{"name":"Add Coupon","event":[{"listen":"prerequest","script":{"id":"4b156952-1884-44aa-b8f9-c692c4b01222","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"8316b8b0-5cfc-4008-87b0-d9f1f426b92e","exec":["// Import the chai assertion library","const chai = require('chai');","","// Set the expect method from chai to a global variable","global.expect = chai.expect;","","// Test the response status code","describe('Response status code', function() {"," it('should be 200 OK', function() {"," expect(pm.response.code).to.equal(200);"," });","});","","// Test the response body","describe('Response body', function() {"," it('should contain a coupon object with the correct properties', function() {"," // Parse the response body as JSON"," const jsonData = pm.response.json();",""," // Check that the coupon object has the expected properties"," expect(jsonData).to.have.property('coupon');"," expect(jsonData.coupon).to.be.an('object');"," expect(jsonData.coupon).to.have.all.keys("," 'id',"," 'reference_name',"," 'code',"," 'note',"," 'coupon_type',"," 'discount_type',"," 'discount_value',"," 'min_amount',"," 'max_amount',"," 'max_discount',"," 'max_uses',"," 'max_uses_user',"," 'uses',"," 'new_user',"," 'start_at',"," 'end_at',"," 'active',"," 'account_id',"," 'created_at',"," 'updated_at'"," );"," });","});",""],"type":"text/javascript"}}],"id":"5637f6e3-05df-4419-91e3-e9591488d7e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"coupon\": {\n \"reference_name\": \"Holiday Campaign\",\n \"code\": \"HOLIDAY\",\n \"note\": \"Great! You have received $10 disount.\",\n \"coupon_type\": \"direct_discount\",\n \"discount_type\": \"flat\",\n \"discount_value\": 10,\n \"min_amount\": 100,\n \"max_amount\": 0,\n \"max_discount\": 10,\n \"max_uses\": 1000,\n \"max_uses_user\": 1,\n \"new_user\": true,\n \"start_at\": \"2022-12-12 00:00:00\",\n \"end_at\": \"2022-12-31 00:00:00\",\n \"active\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/coupons","urlObject":{"path":["v1","coupons"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"5637f6e3-05df-4419-91e3-e9591488d7e4"}],"id":"f2da303b-65a9-499e-b555-9fd0d71925db","description":"

Coupon Object

The coupon object represents a discount coupon that can be applied to an order. It has the following properties:

Properties

\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

Property	Type	Description
`reference_name`	string	A reference name for the coupon. This is for internal use and is not shown to customers.
`code`	string	The code that customers can use to redeem the coupon. This should be unique and easy to remember.
`note`	string	A note that will be shown to customers when they apply the coupon. This can be used to explain the details of the discount.
`coupon_type`	string	The type of coupon. Valid values are `\"direct_discount\"` and `\"gift\"`.
`discount_type`	string	The type of discount. Valid values are `\"flat\"` and `\"percent\"`.
`discount_value`	number	The value of the discount. This can be a flat amount or a percentage, depending on the value of `discount_type`.
`min_amount`	number	The minimum order amount required to use the coupon.
`max_amount`	number	The maximum order amount that the coupon can be applied to.
`max_discount`	number	The maximum discount that can be applied with the coupon.
`max_uses`	number	The maximum number of times the coupon can be used.
`max_uses_user`	number	The maximum number of times a single user can use the coupon.
`new_user`	boolean	Indicates whether the coupon is only available to new users.
`start_at`	string	The start date and time when the coupon becomes available.
`end_at`	string	The end date and time when the coupon expires.
`active`	boolean	Indicates whether the coupon is currently active.

Example

Here is an example of a coupon object:

{\n    \"coupon\": {\n        \"reference_name\": \"Holiday Campaign\",\n        \"code\": \"HOLIDAY\",\n        \"note\": \"Great! You have received $10 disount.\",\n        \"coupon_type\": \"direct_discount\",\n        \"discount_type\": \"flat\",\n        \"discount_value\": 10,\n        \"min_amount\": 100,\n        \"max_amount\": 0,\n        \"max_discount\": 10,\n        \"max_uses\": 1000,\n        \"max_uses_user\": 1,\n        \"new_user\": true,\n        \"start_at\": \"2022-12-12 00:00:00\",\n        \"end_at\": \"2022-12-31 00:00:00\",\n        \"active\": true\n    }\n}\n\n

\n","_postman_id":"f2da303b-65a9-499e-b555-9fd0d71925db"}],"id":"bd49a374-4d65-4ac4-ba2c-65f3b3d7249e","_postman_id":"bd49a374-4d65-4ac4-ba2c-65f3b3d7249e","description":""},{"name":"Webhooks","item":[{"name":"Webhook List","id":"121dd36f-da1f-453d-934a-af4c6fe9e20d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/webhooks?page={{page}}&per_page={{per_page}}","description":"

[ADMIN]

\n\n

Lists all the webhooks ordered by the latest date and time.

\n","urlObject":{"path":["v1","webhooks"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

page number starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

number of records to return in a page

\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"}],"variable":[]}},"response":[],"_postman_id":"121dd36f-da1f-453d-934a-af4c6fe9e20d"},{"name":"Webhook Detail","id":"fa08d478-7bcb-42dc-8b1e-4e8863084b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/webhooks/{{webhook_id}}","description":"

[ADMIN]

\n\n

Get webhook detail.

\n","urlObject":{"path":["v1","webhooks","{{webhook_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa08d478-7bcb-42dc-8b1e-4e8863084b12"},{"name":"Add Webhook","id":"a4013a34-8126-4d49-b9b3-94a475aa1b04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"url\": \"https://yourdomain.com\",\n \"events\": [\n \"user.created\",\n \"user.updated\"\n ],\n \"description\": \"notify about user events\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/webhooks","description":"

[ADMIN]

\n\n

Add a new webhook.

Request

\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

name	required	type	description
`url`	required	`string`	URL of the webhook endpoint
`events`	required	`array`	The list of events to enable for this endpoint
`description`	optional	`string`	description of the webhook

","urlObject":{"path":["v1","webhooks"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a4013a34-8126-4d49-b9b3-94a475aa1b04"},{"name":"Edit Webhook","id":"fb4502ca-600b-4f79-be6d-4c89c60e3232","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"url\": \"https://yourdomain.com\",\n \"events\": [\n \"user.created\",\n \"user.updated\"\n ],\n \"description\": \"notify about user events\",\n \"active\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/webhooks/{{webhook_id}}","description":"

[ADMIN]

\n\n

Edit an existing webhook.

Request

\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

name	required	type	description
`url`	required	`string`	URL of the webhook endpoint
`events`	required	`array`	The list of events to enable for this endpoint
`description`	optional	`string`	description of the webhook
`active`	optional	`boolean`	activate or disable the webhook

","urlObject":{"path":["v1","webhooks","{{webhook_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb4502ca-600b-4f79-be6d-4c89c60e3232"},{"name":"Delete Webhook","id":"ac7236d5-9660-4ac0-9573-11fbcc3763b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/webhooks/{{webhook_id}}","description":"

[ADMIN]

\n\n

Delete a webhook.

\n","urlObject":{"path":["v1","webhooks","{{webhook_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac7236d5-9660-4ac0-9573-11fbcc3763b2"},{"name":"Webhook Logs","id":"061e1e6e-0bba-4b3c-8627-820212579a41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/webhooks/logs?page={{page}}&per_page={{per_page}}&id={{webhook_id}}","description":"

[ADMIN]

\n\n

Lists all the webhook logs ordered by the latest date and time.

\n","urlObject":{"path":["v1","webhooks","logs"],"host":["https://api.tradly.app"],"query":[{"description":{"content":"

page number starts from 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

number of records to return in a page

\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"},{"description":{"content":"

id of the webhook to return logs of specific webhook

\n","type":"text/plain"},"key":"id","value":"{{webhook_id}}"}],"variable":[]}},"response":[],"_postman_id":"061e1e6e-0bba-4b3c-8627-820212579a41"}],"id":"4066158e-3a1b-48f4-9f93-6f334c7628d6","description":"

You can configure webhook endpoint via the API to be notified about events that happen in your Tradly account.

You can configure webhooks from Settings section of our website as well, which provides a user interface for managing your webhook endpoints.

\n","_postman_id":"4066158e-3a1b-48f4-9f93-6f334c7628d6"},{"name":"Delivery","item":[{"name":"Create Order","id":"666673fd-7d73-4378-9023-7101e84fda47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{secret_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"branch\": {\n \"id\": \"20009\"\n },\n \"order_id\": \"891176\",\n \"order_reference\": \"SQP3DR1\",\n \"delivery_type\": 1,\n \"payment_type\": 2,\n \"currency\": \"SAR\",\n \"order_time\": \"2022-06-10T15:30:12Z\",\n \"delivery_slot_from\": \"2022-06-10T16:30:00Z\",\n \"delivery_slot_to\": \"2022-06-10T17:30:00Z\",\n \"amount\": 80,\n \"otp\": \"8890\",\n \"customer\": {\n \"name\": \"Mike\",\n \"mobile\": \"1447220001\",\n \"language\": \"en\"\n },\n \"address\": {\n \"formatted_address\": \"North Street, California\",\n \"coordinates\": {\n \"latitude\": 21.540502633065,\n \"longitude\": 39.20196591669464\n }\n }\n }\n}"},"url":"https://api.tradly.app/delivery/v1/orders","description":"

Create delivery order

\n","urlObject":{"path":["delivery","v1","orders"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"666673fd-7d73-4378-9023-7101e84fda47"}],"id":"ea769882-3295-4631-81ee-d0762944df24","_postman_id":"ea769882-3295-4631-81ee-d0762944df24","description":""},{"name":"Layers","item":[{"name":"Layer List","id":"37b72fa0-809b-4f85-85a6-1bcc51798272","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/layers","urlObject":{"path":["v1","layers"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"37b72fa0-809b-4f85-85a6-1bcc51798272"},{"name":"Layer Detail","id":"adcb5f48-5f23-4af0-b274-4e8d73cac86d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/layers/{{layer_id}}","urlObject":{"path":["v1","layers","{{layer_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"adcb5f48-5f23-4af0-b274-4e8d73cac86d"},{"name":"Create Layer","id":"b3be0874-a351-4297-a3bc-d912263619a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"layer\": {\n \"title\": \"How to deploy React JS app using Docker\",\n \"content\": \"your markdown content here MD or MDX or HTML or any string\",\n \"type\": \"blog\",\n \"tags\": [\n \"node\",\n \"react\",\n \"tech\"\n ],\n \"slug\": \"react123\",\n \"cover_image_path\": \"https://your_domain.com/image.png\",\n \"summary\": \"Welcome to our blog.\",\n \"account_id\": 4\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/layers","urlObject":{"path":["v1","layers"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3be0874-a351-4297-a3bc-d912263619a8"},{"name":"Edit Layer","id":"63ecc07a-ad08-4ef3-bbae-4b19b177c930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"layer\": {\n \"title\": \"How to deploy React JS app using Docker\",\n \"content\": \"your markdown content here MD or MDX or HTML or any string\",\n \"type\": \"blog\",\n \"tags\": [\n \"node\",\n \"react\",\n \"tech\"\n ],\n \"slug\": \"react123\",\n \"cover_image_path\": \"https://your_domain.com/image.png\",\n \"summary\": \"Welcome to our blog.\",\n \"account_id\": 4\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/layers/{{layer_id}}","urlObject":{"path":["v1","layers","{{layer_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"63ecc07a-ad08-4ef3-bbae-4b19b177c930"},{"name":"Delete Layer","id":"7e37d025-55e2-4975-a99b-0391b8e26c41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publishable_key}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"X-Auth-Key","type":"text","value":"{{x_auth_key}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.tradly.app/v1/layers/{{layer_id}}","urlObject":{"path":["v1","layers","{{layer_id}}"],"host":["https://api.tradly.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e37d025-55e2-4975-a99b-0391b8e26c41"}],"id":"62f935d2-b018-48c1-b2d5-964d4a0a90bf","description":"

Layer Object

The layer object represents a content layer that can be created in a mini CMS. It has the following properties:

Properties

\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

Property	Type	Description
`title`	string	The title of the content layer. This will be displayed to users when viewing the content.
`content`	string	The content of the layer. This can be in markdown, MDX, HTML, or any other format supported by the CMS.
`type`	string	The type of content. Valid values are `\"blog\"`, `\"page\"`, `\"article\"`, etc.
`tags`	array	An array of tags that can be used to classify the content.
`slug`	string	A unique identifier for the content. This is used in the URL when viewing the content.
`account_id`	number	The ID of the account that created the content.

Example

Here is an example of a layer object:

{\n    \"layer\": {\n        \"title\": \"How to deploy React JS app using Docker\",\n        \"content\": \"your markdown content here MD or MDX or HTML or any string\",\n        \"type\": \"blog\",\n        \"tags\": [\n            \"node\",\n            \"react\",\n            \"tech\"\n        ],\n        \"slug\": \"react123\",\n        \"cover_image_path\": \"https://your_domain.com/image.png\",\n        \"summary\": \"Welcome to our blog.\",\n        \"account_id\": 4\n    }\n}\n\n

\n","_postman_id":"62f935d2-b018-48c1-b2d5-964d4a0a90bf"}],"event":[{"listen":"prerequest","script":{"id":"cf33f7d8-4c05-442e-a4e9-ad5da0959495","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b64bbefa-1dd1-4dd6-80c0-3eec752d3884","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.tradly.app"}]}