{"info":{"_postman_id":"d4b60293-a36e-41a1-b1f3-ac789026dbad","name":"Laddar","description":"

Welcome to Laddar's API

\n

Here you can find how to integrate Laddar into your existing CRMs, and properiatory systems.

\n

To get started; create an account at https://dashboard.laddar.africa/sign-up. Once you account is setup, head over to the \"API Integration\" section and generate your unique API token/secret pair.

\n

Authentication:

\n

Laddar attaches a header parameter called \"x-auth-sign\" to every request made to your configured endpoints. Please see individual requests to view unique cases.

\n

We recommend validating the passed x-auth-sign for every request received to confirm authenticity.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"242585","collectionId":"d4b60293-a36e-41a1-b1f3-ac789026dbad","publishedId":"2sA35MzK5X","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3282EB"},"publishDate":"2024-07-04T11:01:29.000Z"},"item":[{"name":"Products","item":[{"name":"Fetch All Products","id":"5104dfc7-d99f-45aa-8d11-0a5894aefc3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"},{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"[LADDAR-UNIQUE-REQUEST-REFERENCE]\"\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]","description":"

This endpoint allows Laddar to sync and represent all products from the client's system into Laddar product inventory.

\n

Authentication:

\n

Laddar attaches a header parameter called \"x-auth-sign\" to every request made to your API endpoint.

\n

x-auth-sign = HASH512(YOUR_LADDAR_API_SECRET + reference)

\n

We recommend validating the passed x-auth-sign for every request received to confirm authenticity.

\n","urlObject":{"path":["[YOUR-API-ENDPOINT]"],"host":["[YOUR-API-URL]"],"query":[],"variable":[]}},"response":[{"id":"19e32543-26be-488d-a9f1-a56ea3e9bad2","name":"Fetch All Products","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"},{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"[LADDAR-UNIQUE-REQUEST-REFERENCE]\"\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"products\": [\n {\n \"title\": \"PRODUCT NAME\",\n \"description\": \"PRODUCT DESCRIPTION\",\n \"price\": 150000, // Lowest currency denomination integers only. Ex: kobo, cents etc\n \"external_reference\": \"UNIQUE PRODUCT REFERENCE 0001\",\n \"availability_endpoint\": \"https://myurl.api\", // YOUR ENDPOINT FOR PRODUCT AVAILABILITY CHECK,\n \"images\": [\n \"https://mcn-images.bauersecure.com/wp-images/4234/615x0/vfr2.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3176/615x405/10137107_honda-vfr800-2006.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3134/615x405/11mcbrx2006sba-01.jpg\", \"https://cdn.visordown.com/styles/v2_large/s3/field/image/blackbird.JPG?itok=-qGLQeC6\"\n ], // Valid URL of each image\n \"variants\": [\n {\n \"name\": \"\",\n \"code\": \"\", // Optional. Your system unique reference\n \"options\": [\n {\n \"name\": \"\",\n \"code\": \"\" // Optional. Your system unique reference\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"5104dfc7-d99f-45aa-8d11-0a5894aefc3f"},{"name":"Fetch Product Details","id":"57be1d96-6ec9-489f-997f-143bc6d11622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"},{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_reference\": \"[LADDAR-GENERATED-PRODUCT-REFERENCE]\",\n \"quantity\": 1,\n \"customer\": {\n \"last_name\": \"customer_last_name\",\n \"first_name\": \"customer_first_name\",\n \"email_address\": \"cusomer_email_address\",\n \"phone_number\": \"customer_phone_number\"\n },\n \"timestamp\": \"EPOCH-TIMESTAMP\",\n \"reference\": \"[LADDAR-UNIQUE-REQUEST-REFERENCE]\"\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]","description":"

Laddar Product API:

\n

Laddar provides clients the feature of self-hosting their products.

\n

Laddar will make a call to the client's provided API endpoint, passing the related data object.

\n

An expected response object will be returned by the client.

\n

Authentication:

\n

Laddar attaches a header parameter called \"x-auth-sign\" to every request made to your API endpoint.

\n

x-auth-sign = HASH512(YOUR_LADDAR_API_SECRET + product_reference + reference + quantity + timestamp)

\n

We recommend validating the passed x-auth-sign for every request received to confirm authenticity.

\n

IMPORTANT

\n

Laddar will expect the returned related product to contain the correct product attributes as created and defined by the client during product creation on the Laddar Portal. Objects returned that do not conform to the attributes will be discarded.

\n","urlObject":{"path":["[YOUR-API-ENDPOINT]"],"host":["[YOUR-API-URL]"],"query":[],"variable":[]}},"response":[{"id":"82f5528f-1494-4478-9e22-9a3bbf9b24bd","name":"Fetch Product Details","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"},{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_reference\": \"[YOUR-PROVIDED-UNIQUE-PRODUCT-REFERENCE]\",\n \"reference\": \"[LADDAR-UNIQUE-REQUEST-REFERENCE]\"\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"product\": {\n \"title\": \"PRODUCT NAME\",\n \"description\": \"PRODUCT DESCRIPTION\",\n \"price\": 150000, // Lowest currency denomination integers only. Ex: kobo, cents etc\n \"external_reference\": \"UNIQUE PRODUCT REFERENCE 0001\",\n \"availability_endpoint\": \"https://myurl.api\", // YOUR ENDPOINT FOR PRODUCT AVAILABILITY CHECK,\n \"images\": [\n \"https://mcn-images.bauersecure.com/wp-images/4234/615x0/vfr2.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3176/615x405/10137107_honda-vfr800-2006.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3134/615x405/11mcbrx2006sba-01.jpg\", \"https://cdn.visordown.com/styles/v2_large/s3/field/image/blackbird.JPG?itok=-qGLQeC6\"\n ], // Valid URL of each image\n \"variants\": [\n {\n \"name\": \"\",\n \"code\": \"\", // Optional. Your system unique reference\n \"options\": [\n {\n \"name\": \"\",\n \"code\": \"\" // Optional. Your system unique reference\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"57be1d96-6ec9-489f-997f-143bc6d11622"},{"name":"Availability Check","id":"e26cfeff-350a-4691-ad0b-eefdddb42941","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-token","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"},{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_reference\": \"YOUR-PROVIDED-PRODUCT-UNIQUE-REFERENCE\",\n \"reference\": \"LADDAR-GENERATED-UNIQUE-REFERENCE\"\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]","description":"

This endpoint allows Laddar check the availablity (in-stock) status of a CLIENT HOSTED product.

\n

This action is performed before every sale on Laddar. If not specified, Laddar will omit this check.

\n","urlObject":{"path":["[YOUR-API-ENDPOINT]"],"host":["[YOUR-API-URL]"],"query":[],"variable":[]}},"response":[{"id":"c9c71186-3eea-42fc-a760-06542a6edb6c","name":"Availability Check","originalRequest":{"method":"POST","header":[{"key":"x-api-token","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"},{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_reference\": \"YOUR-PROVIDED-PRODUCT-UNIQUE-REFERENCE\",\n \"reference\": \"LADDAR-GENERATED-UNIQUE-REFERENCE\"\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"available\": true, // True or False\n \"message\": \"Product is in stock\"\n}"}],"_postman_id":"e26cfeff-350a-4691-ad0b-eefdddb42941"},{"name":"Add / Update Product(s)","id":"79945556-a5da-49f6-b8f5-427106778a35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"body":{"mode":"raw","raw":"{\n \"products\": [\n {\n \"title\": \"PRODUCT NAME\",\n \"description\": \"PRODUCT DESCRIPTION\",\n \"price\": 150000, // Lowest currency denomination integers only. Ex: kobo, cents etc\n \"external_reference\": \"UNIQUE PRODUCT REFERENCE\",\n \"availability_endpoint\": \"https://myurl.api\", // YOUR ENDPOINT FOR PRODUCT AVAILABILITY CHECK,\n \"images\": [\n \"https://mcn-images.bauersecure.com/wp-images/4234/615x0/vfr2.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3176/615x405/10137107_honda-vfr800-2006.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3134/615x405/11mcbrx2006sba-01.jpg\", \"https://cdn.visordown.com/styles/v2_large/s3/field/image/blackbird.JPG?itok=-qGLQeC6\"\n ], // Valid URL of each image\n \"variants\": [\n {\n \"name\": \"\",\n \"code\": \"\", // Optional. Your system unique reference\n \"options\": [\n {\n \"name\": \"\",\n \"code\": \"\" // Optional. Your system unique reference\n }\n ]\n }\n ],\n \"campaign_propagate_price\": false // Applicable during an update. Propagates the new price across all related campaigns if set to true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.laddar.africa/v1/connector/products/create.json","urlObject":{"protocol":"https","path":["v1","connector","products","create.json"],"host":["api","laddar","africa"],"query":[],"variable":[]}},"response":[{"id":"5366aed5-0ccb-4d2e-99f8-6bea95ed661f","name":"Add Product(s)","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"body":{"mode":"raw","raw":"{\n \"products\": [\n {\n \"title\": \"PRODUCT NAME\",\n \"description\": \"PRODUCT DESCRIPTION\",\n \"price\": 150000, // Lowest currency denomination integers only. Ex: kobo, cents etc\n \"external_reference\": \"UNIQUE PRODUCT REFERENCE\",\n \"availability_endpoint\": \"https://myurl.api\", // YOUR ENDPOINT FOR PRODUCT AVAILABILITY CHECK,\n \"images\": [\n \"https://mcn-images.bauersecure.com/wp-images/4234/615x0/vfr2.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3176/615x405/10137107_honda-vfr800-2006.jpg\", \"https://mcn-images.bauersecure.com/wp-images/3134/615x405/11mcbrx2006sba-01.jpg\", \"https://cdn.visordown.com/styles/v2_large/s3/field/image/blackbird.JPG?itok=-qGLQeC6\"\n ], // Valid URL of each image\n \"variants\": [\n {\n \"name\": \"\",\n \"code\": \"\", // Optional. Your system unique reference\n \"options\": [\n {\n \"name\": \"\",\n \"code\": \"\" // Optional. Your system unique reference\n }\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.laddar.africa/v1/connector/products/create.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 10:53:58 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.0"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"186"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"message\": \"Request action completed.\",\n \"products\": [\n {\n \"reference\": \"UNIQUE PRODUCT REFERENCE 0001\",\n \"name\": \"PRODUCT NAME\"\n }\n ],\n \"errors\": []\n },\n \"version\": \"1.0.0\"\n}"}],"_postman_id":"79945556-a5da-49f6-b8f5-427106778a35"},{"name":"Enable/Disable Product","id":"48ec3d4a-2048-440e-a94c-f8c487c2013b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":"https://api.laddar.africa/v1/connector/products/:reference/:status/update.json","urlObject":{"protocol":"https","path":["v1","connector","products",":reference",":status","update.json"],"host":["api","laddar","africa"],"query":[],"variable":[{"description":{"content":"

Product reference

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

enable/disable

\n","type":"text/plain"},"type":"any","value":"enable","key":"status"}]}},"response":[{"id":"3fab0225-3e2d-43ee-8d9d-7b00b9945b70","name":"Enable/Disable Product","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":{"raw":"https://api.laddar.africa/v1/connector/products/:reference/:status/update.json","protocol":"https","host":["api","laddar","africa"],"path":["v1","connector","products",":reference",":status","update.json"],"variable":[{"key":"reference","value":"","description":"Product reference"},{"key":"status","value":"","description":"enable/disable"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 11:16:13 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.0"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"84"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"message\": \"Product status updated.\"\n },\n \"version\": \"1.0.0\"\n}"}],"_postman_id":"48ec3d4a-2048-440e-a94c-f8c487c2013b"},{"name":"Delete Product","id":"7bba6681-46b0-475d-9d1b-a85483ce56f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":"https://api.laddar.africa/v1/connector/products/:reference/delete.json","urlObject":{"protocol":"https","path":["v1","connector","products",":reference","delete.json"],"host":["api","laddar","africa"],"query":[],"variable":[{"description":{"content":"

Product reference

\n","type":"text/plain"},"type":"any","value":"","key":"reference"}]}},"response":[{"id":"f227be91-007b-4501-b2f0-b7886ee9b8ad","name":"Delete Product","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":{"raw":"https://api.laddar.africa/v1/connector/products/:reference/delete.json","protocol":"https","host":["api","laddar","africa"],"path":["v1","connector","products",":reference","delete.json"],"variable":[{"key":"reference","value":"","description":"Product reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 11:20:02 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.0"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"90"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"message\": \"Product deleted successfully.\"\n },\n \"version\": \"1.0.0\"\n}"}],"_postman_id":"7bba6681-46b0-475d-9d1b-a85483ce56f2"}],"id":"5e3f4b70-3188-49f8-96a8-769c8c7900ff","_postman_id":"5e3f4b70-3188-49f8-96a8-769c8c7900ff","description":""},{"name":"Campaigns","item":[{"name":"Order Push Service","id":"25695a86-adae-4536-8d43-d04f51b80bd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-token","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"},{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"}],"body":{"mode":"raw","raw":"{\n \"x-ref\": \"UNIQUE-REQUEST-REFERENCE\", // SYSTEM GENERATED, UNIQUE FOR EACH API PUSH\n \"order\": {\n \"reference\": \"LADDAR-GENERATED-ORDER-REFERENCE\",\n \"amount\": \"AMOUNT\",\n \"payment_method\": \"BANK_TRANSFER\", // CASH, CARD, BANK_TRANSFER, MOBILE_MONEY\n \"products\": [\n {\n \"product_reference\": \"UNIQUE-PRODUCT-REFERENCE\", // YOUR PROVIDED UNIQUE PRODUCT REFERENCE, DEFAULTS TO LADDAR GENERATED REFERENCE\n \"quantity\": 1,\n \"variants\": [\n {\n \"reference\": \"UNIQUE-VARIANT-REFERENCE\",\n \"variant_title\": \"VARIANT-NAME\",\n \"option\": \"UNIQUE-VARIANT-OPTION-REFERENCE\",\n \"option_title\": \"VARIANT-OPTION-NAME\"\n }\n ]\n }\n ],\n \"transaction_fee\": 1460, // Payment processor fee charged if any\n \"service_fee\": 35000, // Laddar sales fee\n \"date\": \"DATE\"\n },\n \"campaign\": {\n \"reference\": \"LADDAR-GENERATED-CAMPAIGN-REFERENCE\",\n \"title\": \"CAMPIGN NAME\"\n },\n \"customer\": {\n \"last_name\": \"customer_last_name\",\n \"first_name\": \"customer_first_name\",\n \"email_address\": \"cusomer_email_address\",\n \"phone_number\": \"customer_phone_number\"\n },\n \"agent\": {\n \"reference\": \"AGENT-REFERENCE-NUMBER\",\n \"name\": \"AGENT NAME\",\n \"staff_number\": \"STAFF-NUMBER\",\n \"group\": \"OPTIONAL: Agent group\"\n },\n \"meta\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"tag\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"data_form\": {\n \"\": \"\" // Captured Data Field Value Pair\n },\n \"shipping_option\": {\n \"state\": \"SELECTED STATE\",\n \"location\": \"SELECTED COVERAGE AREA\",\n \"fee\": 50000 // Fee charged to buyer (in currency lowest denomination\n }\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]","description":"

After a successful sale, Laddar will push the related order payload to your configured API endpoint.

\n

A http response code: 200, 201 indicates successful.

\n

Laddar will attempt this push up to a maximum of 10 tries in 15 minutes intervals.

\n

Authentication:

\n

Laddar attaches a header parameter called \"x-auth-sign\" to every request made to your Order Push endpoint.

\n

x-auth-sign = HASH512(YOUR_LADDAR_API_SECRET + : + x-ref).

\n

Example: var hash = (HASH512(CLIENT-API-SECRET + \":\" + x-ref);

\n

The x-ref parameter can be found within the JSON object sent.

\n

We recommend validating the passed x-auth-sign for every request received to confirm authenticity.

\n","urlObject":{"path":["[YOUR-API-ENDPOINT]"],"host":["[YOUR-API-URL]"],"query":[],"variable":[]}},"response":[{"id":"bbf4c388-2f96-4871-a803-52e87b1d1085","name":"Order Push Service","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"},{"key":"x-auth-sign","value":"SYSTEM-GENERATED-AUTH-HASH","type":"text"}],"body":{"mode":"raw","raw":"{\n \"x-ref\": \"UNIQUE-REQUEST-REFERENCE\", // SYSTEM GENERATED, UNIQUE FOR EACH API PUSH\n \"order\": {\n \"reference\": \"LADDAR-GENERATED-ORDER-REFERENCE\",\n \"amount\": \"AMOUNT\",\n \"payment_method\": \"BANK_TRANSFER\", // CASH, CARD, BANK_TRANSFER, MOBILE_MONEY\n \"products\": [\n {\n \"product_reference\": \"UNIQUE-PRODUCT-REFERENCE\", // YOUR PROVIDED UNIQUE PRODUCT REFERENCE, DEFAULTS TO LADDAR GENERATED REFERENCE\n \"quantity\": 1,\n \"variants\": [\n {\n \"reference\": \"UNIQUE-VARIANT-REFERENCE\",\n \"variant_title\": \"VARIANT-NAME\",\n \"option\": \"UNIQUE-VARIANT-OPTION-REFERENCE\",\n \"option_title\": \"VARIANT-OPTION-NAME\"\n }\n ]\n }\n ],\n \"transaction_fee\": 1460, // Payment processor fee charged if any\n \"service_fee\": 35000, // Laddar sales fee\n \"date\": \"DATE\"\n },\n \"campaign\": {\n \"reference\": \"LADDAR-GENERATED-CAMPAIGN-REFERENCE\",\n \"title\": \"CAMPIGN NAME\"\n },\n \"customer\": {\n \"last_name\": \"customer_last_name\",\n \"first_name\": \"customer_first_name\",\n \"email_address\": \"cusomer_email_address\",\n \"phone_number\": \"customer_phone_number\"\n },\n \"agent\": {\n \"reference\": \"AGENT-REFERENCE-NUMBER\",\n \"name\": \"AGENT NAME\",\n \"staff_number\": \"STAFF-NUMBER\",\n \"group\": \"OPTIONAL: Agent group\"\n },\n \"meta\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"tag\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"data_form\": {\n \"\": \"\" // Captured Data Field Value Pair\n },\n \"shipping_option\": {\n \"state\": \"SELECTED STATE\",\n \"location\": \"SELECTED COVERAGE AREA\",\n \"fee\": 50000 // Fee charged to buyer (in currency lowest denomination\n }\n}","options":{"raw":{"language":"json"}}},"url":"[YOUR-API-URL]/[YOUR-API-ENDPOINT]"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Message received\"\n}"}],"_postman_id":"25695a86-adae-4536-8d43-d04f51b80bd6"},{"name":"Fetch All Orders","id":"684f72b6-8aa4-4971-b875-631b98ae6fdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":"https://api.laddar.africa/v1/connector/orders/:page/all.json","description":"

Retrieve all successful orders under your account. API returns 1000 records max per call. Use the page path parameter to retrieve more data.

\n","urlObject":{"protocol":"https","path":["v1","connector","orders",":page","all.json"],"host":["api","laddar","africa"],"query":[],"variable":[{"type":"any","value":"1","key":"page"}]}},"response":[{"id":"d145bcae-b43a-4d23-b30c-87cceb5b9013","name":"Fetch All Orders","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":{"raw":"https://api.laddar.africa/v1/connector/orders/:page/all.json","protocol":"https","host":["api","laddar","africa"],"path":["v1","connector","orders",":page","all.json"],"variable":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 07:52:28 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.0"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"61"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"data\": {\n \"orders\": [] // Contains a list of same return object from order push service\n },\n \"version\": \"1.0.0\"\n}"}],"_postman_id":"684f72b6-8aa4-4971-b875-631b98ae6fdb"},{"name":"Get Single Order","id":"96d80058-e772-4560-b71a-e64770032c7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":"https://api.laddar.africa/v1/connector/orders/:reference/get.json","description":"

Retrieve a single order using the order reference. This can be found for every sale on the Laddar dashboard and also sent via the Order Push Service.

\n","urlObject":{"protocol":"https","path":["v1","connector","orders",":reference","get.json"],"host":["api","laddar","africa"],"query":[],"variable":[{"description":{"content":"

Order Reference

\n","type":"text/plain"},"type":"any","value":"","key":"reference"}]}},"response":[{"id":"2e42c749-5c05-43bc-b6f6-9a5dc61c7ed6","name":"Get SIngle Order","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-ACCOUNT-API-KEY]","type":"text"}],"url":{"raw":"https://api.laddar.africa/v1/connector/orders/:reference/get.json","protocol":"https","host":["api","laddar","africa"],"path":["v1","connector","orders",":reference","get.json"],"variable":[{"key":"reference","value":"","description":"Order reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 07:53:35 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.0"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"1354"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"data\": {}, // Contains same return object from order push service\n \"version\": \"1.0.0\"\n}"}],"_postman_id":"96d80058-e772-4560-b71a-e64770032c7a"}],"id":"d261bce0-7178-41bb-a0f1-51252be415c3","_postman_id":"d261bce0-7178-41bb-a0f1-51252be415c3","description":""},{"name":"API Integration","item":[{"name":"Init","id":"d034401e-485b-4ae2-be69-cf7a1e028896","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"default"}],"url":"https://api.laddar.africa/v1/app/init.json","description":"

Initialise endpoint. This endpoint returns the required information needed to perform a successful sale.

\n\n","urlObject":{"protocol":"https","path":["v1","app","init.json"],"host":["api","laddar","africa"],"query":[],"variable":[]}},"response":[],"_postman_id":"d034401e-485b-4ae2-be69-cf7a1e028896"},{"name":"Sell","id":"a84368a4-32a1-4f4e-a136-7f2aa6a87d4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"default"},{"key":"x-agent-ref","value":"","type":"default"}],"body":{"mode":"raw","raw":"{\n \"payment_method\": \"FREE\",\n \"customer\": {\n \"first_name\": \"Ikenna\",\n \"last_name\": \"Iloeje\",\n \"email_address\": \"ikenna@laddar.africa\",\n \"phone_number\": \"234803xxxxxxx\"\n },\n \"products\": [\n {\n \"reference\": \"9c330ea2-639d-41a6-a26c-5d67b21dbca9\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.laddar.africa/v1/app/sell.json","description":"

Be sure to call the Init endpoint to obtain all required parameters before performing a sale.

\n

Contact the Laddar Account for a list of agents and their unique identifiers. This is required in the x-agent-ref header parameter.

\n","urlObject":{"protocol":"https","path":["v1","app","sell.json"],"host":["api","laddar","africa"],"query":[],"variable":[]}},"response":[],"_postman_id":"a84368a4-32a1-4f4e-a136-7f2aa6a87d4f"},{"name":"Fetch Order","id":"1253c119-1be7-4762-8cb6-e6bbae28f6e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"default"}],"url":"https://api.laddar.africa/v1/app/orders/:orderReference/fetch.json","description":"

Returns a previously generated sell order.

\n","urlObject":{"protocol":"https","path":["v1","app","orders",":orderReference","fetch.json"],"host":["api","laddar","africa"],"query":[],"variable":[{"id":"e2313424-2f92-4bad-8931-745bb7a2d687","type":"any","value":"","key":"orderReference"}]}},"response":[],"_postman_id":"1253c119-1be7-4762-8cb6-e6bbae28f6e5"}],"id":"08633cd2-ad1c-4b64-a92c-916e7428d55e","_postman_id":"08633cd2-ad1c-4b64-a92c-916e7428d55e","description":""},{"name":"Leads","item":[{"name":"Create Lead","id":"81902dfb-00ee-4d77-bc2e-3ebc9be9e558","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bucket\": \"reference/ID\", // Lead bucket reference (ID)\n \"name\": \"Chika Temilolowa Abdul\",\n \"email_address\": \"\", // Lead email adress\n \"phone_number\": \"\", // Lead phone number. Note: A lead must have atleast an email or phone number\n\n // A dictionary of attribute key:value. Refer to the attributes of the lead profile from your dashboard\n \"attributes\": {\n \"[attribute_key]\": \"[attribute_value]\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.laddar.africa/v1/connector/leads/create.json","urlObject":{"protocol":"https","path":["v1","connector","leads","create.json"],"host":["api","laddar","africa"],"query":[],"variable":[]}},"response":[],"_postman_id":"81902dfb-00ee-4d77-bc2e-3ebc9be9e558"},{"name":"Delete Lead","id":"56fc9cc5-d6a7-4450-a23b-fdc741d78203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"}],"url":"https://api.laddar.africa/v1/connector/leads/:reference/delete.json","urlObject":{"protocol":"https","path":["v1","connector","leads",":reference","delete.json"],"host":["api","laddar","africa"],"query":[],"variable":[{"type":"any","value":"","key":"reference"}]}},"response":[],"_postman_id":"56fc9cc5-d6a7-4450-a23b-fdc741d78203"},{"name":"Convert Lead","id":"37edf1b7-0822-402d-a2f4-d093b63e4097","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"[YOUR-LADDAR-API-TOKEN]","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"\" // Lead reference. Get the reference from create lead endpoint or from your dashboard\n}","options":{"raw":{"language":"json"}}},"url":"https://api.laddar.africa/v1/connector/leads/convert.json","urlObject":{"protocol":"https","path":["v1","connector","leads","convert.json"],"host":["api","laddar","africa"],"query":[],"variable":[]}},"response":[],"_postman_id":"37edf1b7-0822-402d-a2f4-d093b63e4097"}],"id":"9e489108-1628-43ed-aa8b-9123be92881e","_postman_id":"9e489108-1628-43ed-aa8b-9123be92881e","description":""}]}