{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aaf2ccce-ce3f-46ae-90a2-02b1259f8898","name":"Amrod's Client Vendors 2.0.11","description":"This documentation provides Amrod's customers with detailed information on the API endpoints that are available for use to integrate into our solutions and our data.\n\nTo **gain access** to these API's please complete the following form  \n[https://content.amrod.co.za/new-api-access-request](https://content.amrod.co.za/new-api-access-request).  \n  \nFor more information about the API's please visit this url: [https://content.amrod.co.za/new-api-resources<br>](https://content.amrod.co.za/new-api-resources)\n\nIf you have any further access issues once your credentials are provided, please email [<u>api.support@amrod.co.za</u>](https://mailto:api.support@amrod.co.za).\n\n# Important URLS\n\n**Authentication URL**\n\n[https://identity.amrod.co.za](https://identity.amrod.co.za)\n\n**Authentication Get Token URL**\n\n[https://identity.amrod.co.za/VendorLogin](https://identity.amrod.co.za/VendorLogin)\n\n**Vendor API URL**\n\n[https://vendorapi.amrod.co.za](https://vendorapi.amrod.co.za)\n\n## \"The API is not working in my browser\"\n\n**You cannot access the vendor API by visiting the url in a web browser**  \nThe API does not allow you to access the information by visiting it in a browser. It needs to be connected via a IDE, backend code or postman. Please see [https://forum.amrod.co.za/topic/37/can-i-get-a-token-by-visiting-the-url-in-my-browser](https://forum.amrod.co.za/topic/37/can-i-get-a-token-by-visiting-the-url-in-my-browser) for more info.\n\n# Ver 2.0.11 - Pricing and Stock Mapping Details\n\n## Notice Date: 2026-02\n\nWe have elaborated on the mapping / matching of Stock and Pricing Endpoints to further explain that this is done on a Products' Variant Full Code. Please see appropriate sections for Stock and Pricing for more information.\n\n# Ver 2.0.10 - Summary\n\n## Deployment Date: 2025-11\n\nA new Colour Group endpoint has been created. The purpose of this is to provide a grouping of similar colours e.g. A group called \"Blue\" would include Cyan, Light Blue and Dark Blue.\n\nThe previous Colour Swatch endpoint has been updated as the IsDeleted field / flag has been deprecated and has been removed.\n\n# Ver 2.0.9 - Summary\n\n## Deployment Date: 2025-09\n\nCategory endpoint has been updated to include Unique ID that identifies each Nested Category. This ID is also added in the product endpoints so that you can easily link the product to the correct category.\n\nThere are changes within the Product Module and Category Module. Please view those sections for more information.\n\n# Ver 2.0.8 - Summary\n\n## Deployment Date: 2025-02\n\nInclusive Branding Specials have been upgraded to include a position to which that special applies to.\n\n# Ver 2.0.7 - Summary\n\n## Deployment Date: 2024-10\n\nColour Swatch endpoint has been added to allow one to view the actual colour # / HEX(s) for all our products.\n\n# Ver 2.0.6 - Summary\n\n## Deployment Date: 2024-08\n\n_**!!! Important API Availabily Time Change**_\n\n1. The API's will not be available between the times of 00:00 and 01:00\n    \n2. These times are GMT+2\n    \n3. Any calls made to the API including products, pricing and stock will return a **204 HTTP Response**\n    \n    1. This means it will return a success but with no content returned\n        \n4. This has been implemented to ensure that all content is sync, manipulated and prepared to be correct for all users to consume\n    \n\n# Ver 2.0.5 - Summary\n\n## Deployment Date: 2024-02\n\n1. Includes additional insights for Authentication challenges\n    \n    1. Includes 3 new return values if login not successful\n        \n    2. Includes common mistakes in inputting the values\n        \n2. Included information on Inclusive Branding\n    \n    1. Outlined the 4 different Branding Flags\n        \n\n# Ver 2.0.4 - Summary\n\n## Deployment Date: 2023-10\n\n1. Includes additional info for promotional flags on Products\n    \n2. Single Sign-on and API and Website Access\n    \n3. Determine if a record is NEW, UPDATED or to be DELETED in Get Updated End Point\n    \n\n# Ver 2.0.3 - Summary\n\n## Deployed Date: 2023-06-20\n\nIncludes minor updates based on internal review + further elaboration on unclear areas.\n\n# Ver 2.0.2 - Summary\n\n## Deployed Date: 2023-06-09\n\nDocumentation review and updates.\n\n# Ver 2.0.1 - Summary\n\n## Deployed Date: 2023-06-01\n\nAll modules / endpoints are provided with 2 distinct options:\n\n1. Get All\n    \n2. Get Changes\n    \n\n## Get All\n\nThe **Get All** endpoints can be found in each module and returns the full dataset of all the information within that specific module. Data found in the **Get All** endpoints are updated once a day therefore if you have called this endpoint already there would be no need to call it within the next 24hrs as information you will receive would be the same as the prior call.\n\n## Get Changes\n\nThe **Get** **Changes** endpoints can be found in each module and returns only the last changes that have been made within the last 24hrs for a specific module. Data found in the **Get Changes** endpoints are updated once a day and **only** contain the changes that have been made within the last 24hr period therefore if you have called this endpoint already there would be no need to call it within the next 24hrs as information you will receive would be the same as the prior call. As these endpoints only return changes for this period it means that changes older than 24hrs (2 days) are not available.\n\nIf you do not utilise this endpoint to keep your data updated daily OR miss a day you would need to call the **Get All** endpoint to get the latest copy of all data.\n\n# Product Structure\n\nEach product is made up of 2 elements\n\n- Variant\n    \n- Base\n    \n\n## Variant\n\nThe variant is the actual item that is sold. It generally comes in a colour or a size and each variant is a combination of the 2 e.g. If a t-shirt is sold in 3 colours with each having 4 sizes, then there are 12 variants (4 x 3).\n\n## Base\n\nThe Base is the default information about a product. It contains important information such as branding information that is common to all variants.\n\nIt isn't something that one can buy e.g. If a t-shirt is sold in 3 colours with each having 4 sizes, one cannot order a t-shirt by itself as it is not a sellable product, you would have to define the size and colour first.\n\n# Codes (SKU)\n\nWe have 2 types of codes in our system.\n\n- Simple\n    \n- Full\n    \n\n## Simple\n\nThe simple code is the code of the \"Base\" item as defined above. It is used for information common to all of the products in that set and does not include any size or colour information.\n\n## Full\n\nThe full code is the code of the \"Variant\" item as defined above. It is used to define the exact size and or colour of the item you are looking to order.\n\n# Branding Options\n\nThe Product Module is split into 2 distinct endpoints:\n\n1. With Branding\n    \n2. Without Branding\n    \n\nThe purpose is to allow each customer the option of what information they require for use within their business and systems whilst keeping the information optimized and easy to use.\n\n## Branding Positions\n\nPositions are included in the product schema. They are provided at the a **Base level** and applies to each variant. Each Position includes 1 or many branding methods available for that position. As not all methods are available for all colours, each method (within a position) includes a field for the \"excluded\" colours e.g. Sublimation is only offered on white items and therefore this method would include the remaining colours in the \"Excluded\" field. This list of excluded values is a comma separated list of colour codes and means that any of the variants of that colour will all be unable to brand that method in that position.\n\n## Branding Pricing\n\nEach Branding Code has a few pricing options.\n\nAll products with the same Branding Codes will have the same pricing structure and within that Branding Code you would use a combination of the Branding Code, QTY ordered and the colour options selected to get the correct pricing for a specific order.\n\n**Note:** Because of the above we recommend using this as a \"look up\" table to be synced daily only once in order to get all main values up to date. Your logic on check out / order placement would then select the appropriate matching pricing.\n\n## Inclusive Branding\n\nMost products contain an Inclusive Branding Method/Option which has a combination of offerings from free branding of a branding code to multiple positions etc.\n\nUnlike Branding Pricing, each Inclusive Branding is per product and at the Branding Position level. These Inclusive Branding Method/Options are in addition to the standard Branding Positions and methods outlined above. E.g. If a product has Embroidery on Position A as well as a Free Embroidery on Position A it would have 2 options for a user to choose from. This is because you have multiple positions so Embroidery can be on Position A and B but only free on Position A.\n\nInclusive Branding is not only specific to a product and its method but also specific to a position. This is because, in some instances, we have multiple positions that may have the same method however only the specific position is included as a special.\n\nThe structure of this is provided the same as the previous Feed / XML / API.\n\n- Inclusive Brandings\n    \n    - This module is used to get Inclusive Branding information.\n        \n- inclusive Branding Prices\n    \n    - This module is used to get Inclusive Branding Pricing information. Inclusive Brandings include a replacement code which indicates that if Inclusive Branding is used then the branding code needs to be replaced with a new one.\n        \n- Branding Pricing\n    \n    - This module is used to get all Branding Prices per Branding Code.\n        \n\n**Note:** All Branding related endpoints have been moved to a folder called \"Branding\". These endpoints are only required if you intend to utilise branding pricing and Inclusive Branding on your solution. These are master lookups and do not include differentials.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3985402","team":100312,"collectionId":"aaf2ccce-ce3f-46ae-90a2-02b1259f8898","publishedId":"2sBXcEmgp6","public":true,"publicUrl":"https://newapidocs.amrod.co.za","privateUrl":"https://go.postman.co/documentation/3985402-aaf2ccce-ce3f-46ae-90a2-02b1259f8898","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"26BFF1"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This documentation provides Amrod's customers with detailed information on the API End Points that are available for use to integrate into our solutions and our data. It includes and outlines recommended usages and scenarios to better guide your development and integration."},{"name":"title","value":"Amrod Customer / Vendor API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/72ba1e0b-4dbb-4380-aa7e-b804a4fbff56/YW1yb2QtbG9nby13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"26BFF1"}},{"name":"light","logo":"https://content.pstmn.io/c3bbad2d-f27a-4132-8693-f364763af893/YW1yb2QtbG9nby1jb2xvci1wbGFpbi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"26BFF1"}}]}},"version":"8.10.1","publishDate":"2026-02-23T15:52:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Amrod Customer / Vendor API Documentation","description":"This documentation provides Amrod's customers with detailed information on the API End Points that are available for use to integrate into our solutions and our data. It includes and outlines recommended usages and scenarios to better guide your development and integration."},"logos":{"logoLight":"https://content.pstmn.io/c3bbad2d-f27a-4132-8693-f364763af893/YW1yb2QtbG9nby1jb2xvci1wbGFpbi5wbmc=","logoDark":"https://content.pstmn.io/72ba1e0b-4dbb-4380-aa7e-b804a4fbff56/YW1yb2QtbG9nby13aGl0ZS5wbmc="}},"statusCode":200},"environments":[{"name":"Live Environment","id":"7b68798e-8f1b-4ed3-ab87-6766fa34e133","owner":"3985402","values":[{"key":"IdentityServerUrl","value":"https://identity.amrod.co.za","enabled":true,"type":"default"},{"key":"CatalogueVendorApiUrl","value":"https://vendorapi.amrod.co.za","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0c87eb3958f76810c0bf4a011ebaf95fb5a813641a6b1c238c85305734e20378","favicon":"https://amrod.co.za/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Live Environment","value":"3985402-7b68798e-8f1b-4ed3-ab87-6766fa34e133"}],"canonicalUrl":"https://newapidocs.amrod.co.za/view/metadata/2sBXcEmgp6"}