The purpose of this API documentation is to give suppliers API level interactions next to the use of the suppliers portal.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22878449","collectionId":"2390762e-9a68-4c85-bf7d-356dd5561aa4","publishedId":"VUqmvzLU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4ab69c"},"publishDate":"2022-08-17T21:28:25.000Z"},"item":[{"name":"Benefits","item":[],"id":"2f03dd15-c1a6-4b37-9513-3b424f222758","description":"Real-time information for the sales team;
\nTime savings for retailers in the field of incoming and outgoing orders;
\nTime saving for your organization through efficient ordering process
\nSupporting dealers by providing generic order information for the webshop;
\nData-driven sales and marketing campaigns.
\nStart
\n* Get access to our API's using your access key
\nDealernetwork sales interaction
\n* List your dealernetwork locations/stores
* Check if a dealer granted you access
* Get stocklists
* Get saleslists
(Purchase and Sales) Order handling
\n* Get order info
* List purchase orders
* Create order
The host for Web API v1 requests can be https://core.1-retailgear.org and depends on your purpose of calling that API.
\nAll microservices required are listed below.
\nAll requests must be made over HTTPS. The API does not support HTTP.
\nYou must provide an authorization header as described in Authentication.
\nFor a quick first demo, you may use Postman. We prepared a Postman collection that allows you to step through the most important functions of this API.
\nHow to get your access-keys?
Contact the supplier business owner to get the supplier access keys.
1. Supplier business owner signs in to the portal
2. Goes to 'Developer access tools'
3. Create 'access key' button
4. After the generation process copies the API_KEY and SECRET_KEY.
After you generate your API_KEY you can see you show only SECRE_KEY here copy that SECRET_KEY and store it in your computer because your SECRET_KEY is visible at that moment only.
\nyou can copy your ACCESS_KEY from here. (Check in above snapshot)
\nAfter you generated your API_KEY succesfully your SECRET_KEY will be visible aswell.
\nWhenever calling any of the API's, make sure you add this accessKey into the header section.
\n3. Insert your API key and secret to get your personalized Postman environment:
\nClick here to generate the Postman environment file Generate Environment
\n4. Download the Postman collection.
\n5. Start Postman and select Upload Files from the Import dialog:
\nFile > Import (Ctrl+O)
6. Select the collection and environment files that you downloaded:
\n7. The Postman screen should now look like this:
\n8. Select the Supplier API v1 environment:
\nYou can pass the API key into a REST API call as a query parameter with the following format. Replace API_KEY , SECRET_KEY with the key string of your API key.
curl --location -g --request POST '{{core-url}}/business/products/list' \\\n--header 'x-access-key: API_KEY' \\\n--header 'x-secret-key: SECRET_KEY' \\\n--header 'x-auth-type: x-access-key' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"iBusinessId\": \"6141b98ab97b703dcb678c49\",\n \"skip\": 0,\n \"limit\": 5,\n \"sortBy\": \"\",\n etc.....\n}'\n\nYou can just replace your ACCESS_KEY and SECRET_KEY in the Postman Environment file.
\nFollow this step to replace your environment file
\nOpen Postman:
If you haven't already, open the Postman application.
Navigate to Environments:
On the left sidebar, click on the \"Environments\" tab.
Access Import Feature:
In the top right corner of the Environments tab, click on the \"Import\" button.
Choose File:
Select the \"Choose Files\" button and locate the Postman environment JSON file on your computer.
Select Environments File:
Pick the Postman environment JSON file you want to import.
Import:
Click the \"Open\" or \"Import\" button to initiate the import process.
Verify Import:
Postman will confirm the successful import of the environment. You should now see the imported environment listed in the Environments tab.
It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"limit\": 100,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": {},\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/partners/list","description":"The \"Get Business Partners\" API is a pivotal component within various business systems, facilitating the retrieval of comprehensive information about partners, collaborators, or affiliates. This API acts as a conduit between the core software application and the database or system business partner data, enabling seamless access to essential partner details.
\niBusinessId: Own supplier's unique code
\n","urlObject":{"path":["api","v1","business","partners","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[{"id":"76a4ce82-310c-4326-81b3-e3c477d8e01f","name":"200","originalRequest":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"limit\": 100,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": {},\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/partners/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 Feb 2024 09:39:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"organization-id, authorization, verification server-token"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"result\": [\n {\n \"_id\": \"BUSINESS_PARTNER_ID\",\n \"iBusinessId\": \"BUSINESS_ID\",\n \"iSupplierId\": \"SUPPLIER_ID\",\n \"sEmail\": \"abcd@example.com\",\n \"sName\": \"ABCD\",\n \"sNameSlug\": null,\n \"sWebsite\": \"www.example.com\",\n \"oPhone\": {\n \"sCountryCode\": \"+91\",\n \"sMobile\": \"0000000000\",\n \"sLandLine\": \"000000000000\",\n \"sFax\": \"000000000000\",\n \"bWhatsApp\": true\n },\n \"oAddress\": {\n \"attn\": {},\n \"street\": \"STREET\",\n \"houseNumber\": \"HOUSE_NUMBER\",\n \"houseNumberSuffix\": \"SUFFIX\",\n \"postalCode\": \"POSTAL_CODE\",\n \"city\": \"CITY\",\n \"country\": \"COUNTRY\",\n \"countryCode\": \"COUNTRY_CODE\",\n \"state\": \"STATE\"\n },\n \"nPurchaseMargin\": 0,\n \"bPreFillCompanySettings\": true,\n \"bEntryMethodCustomerValue\": true,\n \"aBankDetail\": [],\n \"eType\": \"default\",\n \"aRetailerComments\": [],\n \"eFirm\": \"private\",\n \"eStatus\": \"y\",\n \"brands\": [],\n \"businesspartners\": {\n \"_id\": \"BUSINESS_PARTNER_ID\",\n \"eAccess\": \"y\",\n \"sEmail\": \"example@example.com\",\n \"sName\": \"ABC\"\n }\n }\n ],\n \"count\": {\n \"totalData\": 1\n }\n }\n ]\n}"},{"id":"fd54878e-2c3b-4d14-b6fb-65afcb848152","name":"401","originalRequest":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key","disabled":true},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key","disabled":true},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"limit\": 100,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": {},\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/partners/list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 Feb 2024 09:48:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"organization-id, authorization, verification server-token"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"1 Authentication Error, Please try logging again\",\n \"data\": {}\n}"}],"_postman_id":"0d27e5e5-3c52-4e8d-9bae-395363f5a773"},{"name":"Get Partner","id":"c778c346-602c-4218-8bac-d39d115dd2cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{core-url}}/api/v1/business/partners/{{iBusinessPartnerId}}?iBusinessId={{iBusinessId}}","description":"To get a single businessPartner including all details you can call this API. This API can be used to verify to shops address to for example create a Purchase/Sales order. See section 'order handling'.
\n","urlObject":{"path":["api","v1","business","partners","{{iBusinessPartnerId}}"],"host":["{{core-url}}"],"query":[{"key":"iBusinessId","value":"{{iBusinessId}}"}],"variable":[]}},"response":[],"_postman_id":"c778c346-602c-4218-8bac-d39d115dd2cc"},{"name":"Get Common Brands","id":"6aa26cc1-7de5-442b-8e76-78ec5740f542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/brands/business-partner/commonBrands/{{iBusinessId}}","description":"This API can be used to discover the common businessBrand documents you and your businesspartner have. For example to filter out all your shops which sell a particular brand. Based on this list you're also able to see which product information your businessPartner uses.
\n","urlObject":{"path":["api","v1","business","brands","business-partner","commonBrands","{{iBusinessId}}"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6aa26cc1-7de5-442b-8e76-78ec5740f542"}],"id":"9cf60363-2cb5-44c5-b531-80d8afd9ece7","description":"Your company and your retailers are eachothers business partners. Every retailer which added your company as their supplier automatically creates a 'business partner' entry.
\n(Your) Company X's documents:
\nStore A (businessPartner type: default)
\nStore B (businessPartner type: default)
\nStore A's documents :
\nCompany X (businessPartner type: supplier, eAccess: false)
\nCompany Y (businessPartner type: supplier, eAccess: true)
\nStore B's documents:
\nCompany X (businessPartner type: supplier, eAccess: true)
\nTo list down your connected stores query on:
{ type: default, iBusinessid: youriBusinessid }
To see if you have access to a certain store:
{ type: supplier, iSupplierId: youriBusinessid, iBusinessId: shopsBusinessId, businessPartner.eAccess: true }
You can find an example in the suppliers panel:
\nIt should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{core-url}}/api/v1/suppliers/{{iBusinessId}}","description":"The \"Get Supplier Details\" API is a critical component of Prismanote software systems that enables businesses to retrieve comprehensive information about their suppliers directly from their backend databases or systems. This API serves as a bridge between the Prismanote software and the supplier's database, allowing seamless access to essential supplier details.
\niBusinessId: Own supplier's unique code
\n","urlObject":{"path":["api","v1","suppliers","{{iBusinessId}}"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f0d85e5-4668-45bf-9604-07536b1b8587"},{"name":"Get Partners","event":[{"listen":"test","script":{"id":"eeb87296-a4d0-4ffb-974b-efbece987f32","exec":[""],"type":"text/javascript"}}],"id":"241b1939-befa-4e33-a404-6b402636ccce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"limit\": 100,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": {},\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/partners/list","description":"The \"Get Partners\" API is a pivotal component within various business systems, facilitating the retrieval of comprehensive information about partners, collaborators, or affiliates. This API acts as a conduit between the core software application and the database or system business partner data, enabling seamless access to essential partner details.
\niBusinessId: Own supplier's unique code
\n","urlObject":{"path":["api","v1","business","partners","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"241b1939-befa-4e33-a404-6b402636ccce"},{"name":"Get Business Partner Details","event":[{"listen":"test","script":{"id":"e3ca937f-6ee4-435f-a0df-05f50aa73111","exec":[""],"type":"text/javascript"}}],"id":"f229a883-5e9c-4c2d-ac10-c536d78813c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{core-url}}/api/v1/business/partners/:iBusinessPartnerId?iBusinessId={{iBusinessId}}","description":"The \"Get Business Partner Details\" API is a fundamental component within business systems, designed to retrieve comprehensive information about partners, collaborators, or affiliates. This API acts as a gateway between the core software application and the database or system business partner data, facilitating seamless access to essential partner details.
\niBusinessId: Own supplier's unique code
\niBusinessPartnerId: The code of the contact document of the 'supplier-store relationship'
\n","urlObject":{"path":["api","v1","business","partners",":iBusinessPartnerId"],"host":["{{core-url}}"],"query":[{"description":{"content":"Your Unique Store Code
\n","type":"text/plain"},"key":"iBusinessId","value":"{{iBusinessId}}"}],"variable":[{"description":{"content":"Unique Code of your store partner
\n","type":"text/plain"},"type":"any","value":"{{iBusinessPartnerId}}","key":"iBusinessPartnerId"}]}},"response":[],"_postman_id":"f229a883-5e9c-4c2d-ac10-c536d78813c6"},{"name":"Get Business Details","event":[{"listen":"test","script":{"id":"552cf041-a8d6-4e04-b3f4-9410031476c5","exec":[""],"type":"text/javascript"}}],"id":"a2915c21-bacb-4570-a3c9-ad4dae9583bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{core-url}}/api/v1/business/:iBusinessId","description":"The \"Get Business Details\" API serves as a foundational component within business systems, facilitating the retrieval of comprehensive information about various entities, such as companies, organizations, or establishments. This API acts as a conduit between the core software application and the database or system business data, enabling seamless access to essential business details.
\niBusinessId: Own supplier's unique code.
\n","urlObject":{"path":["api","v1","business",":iBusinessId"],"host":["{{core-url}}"],"query":[],"variable":[{"description":{"content":"Your Unique Store Code
\n","type":"text/plain"},"type":"any","value":"{{iBusinessId}}","key":"iBusinessId"}]}},"response":[],"_postman_id":"a2915c21-bacb-4570-a3c9-ad4dae9583bd"},{"name":"Get Client Group","id":"ecbf9edf-14d6-412a-adbd-4cab7f336ac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 6,\n \"searchValue\": \"\",\n \"skip\":0,\n \"sortBy\":\"\",\n \"sortOrder\":\"\",\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/partners/list","description":"The \"Get Client Group\" API is an essential tool within business systems, allowing users to retrieve a comprehensive list of client groups or segments. This API serves as a bridge between the core software application and the database or system business client group data, facilitating seamless access to essential client segmentation details.
\niBusinessId: Own supplier's unique code.
\n","urlObject":{"path":["api","v1","business","partners","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ecbf9edf-14d6-412a-adbd-4cab7f336ac2"},{"name":"Get Article Group","id":"e64699bd-23da-40d5-9a9f-fe074d728fd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bShowDeletedArticle\": false,\n \"skip\": 0,\n \"limit\": 25,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"aLanguage\": [\"en\", \"nl\", \"fr\", \"es\", \"de\", \"da\", \"ar\", \"da\", \"sv\", \"nb\", \"fi\", \"pl\", \"it\", \"ms\"],\n \"oFilterBy\": {},\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"bFetchAll\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/article-group/list","description":"The \"Get Article Group\" API is a key component within content management systems and knowledge databases, allowing users to retrieve a categorized list of articles or content pieces. This API serves as a bridge between the core software application and the database or system business article group data, enabling seamless access to essential categorization details.
\niBusinessId: Own supplier's unique code.
\n","urlObject":{"path":["api","v1","business","article-group","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e64699bd-23da-40d5-9a9f-fe074d728fd4"},{"name":"Get Brands","id":"9baecdb1-165c-4841-b6ab-a7f52735cbe5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 6,\n \"searchValue\": \"\",\n \"skip\":0,\n \"sortBy\":\"\",\n \"sortOrder\":\"\",\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/brands/list","description":"The \"Get Brands\" API is an essential tool within various e-commerce platforms and retail management systems, enabling users to retrieve comprehensive information about brands and their products. This API serves as a connection point between the core software application and the database or system business brand data, facilitating seamless access to essential brand details.
\niBusinessId: Own supplier's unique code.
\n","urlObject":{"path":["api","v1","business","brands","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9baecdb1-165c-4841-b6ab-a7f52735cbe5"},{"name":"Get Stocklist","id":"fea6502b-c3e4-43c0-a4b4-b6a9187215a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"iLocationId\": \"{{iLocationId}}\",\n \"searchValue\": \"\",\n \"skip\": 0,\n \"limit\": 10,\n \"sortBy\": \"dCreatedDate\",\n \"sortOrder\": \"asc\",\n \"bShowProductWithStock\": true,\n \"oFilterBy\": {\n \"iBusinessPartnerId\": [\n \"{{iBusinessPartnerId}}\"\n ],\n \"iBusinessBrandId\": [],\n \"iArticleGroupId\": [],\n \"iLocationId\": []\n },\n \"id\": \"{{iBusinessPartnerId}}\",\n \"csvExport\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/stock-list/{{iBusinessId}}","description":"The \"Get Stock List\" API is a vital component within inventory management systems, empowering users to retrieve comprehensive data regarding stock levels and inventory items. This API acts as a connection point between the core software application and the database or system business stock data, facilitating seamless access to essential inventory details.
\niBusinessId: Own supplier's unique code
\niLocationId: Own supplier's unique location code
\niBusinessPartnerId: The code of the contact document of the 'supplier-store relationship'
\nid: Same as iBusinessPartnerid
\n","urlObject":{"path":["api","v1","stock-list","{{iBusinessId}}"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fea6502b-c3e4-43c0-a4b4-b6a9187215a8"}],"id":"23433ace-dc8e-4b30-b4e0-16b59aea3379","description":"To get information about your dealers actual stock. You can call you our microservice: core services
\nInformation can be retrieved on the internet by means of a 'website link'. Retrieving information through an API works almost the same way. You go to a 'website link' and you get data back. Such a website link should be seen as a 'door' (URL) that allows you to retrieve data. Behind each URL is its own type of 'data' such as products, sales data, etc.
\n","_postman_id":"23433ace-dc8e-4b30-b4e0-16b59aea3379"},{"name":"Get Sales List From Your Dealer (retailer -> consumer sales)","item":[{"name":"Get Sales List","id":"38f6683d-96dd-40bb-8588-9b60e5bb5fcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-\"access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filterDates\": {},\n \"iSupplierId\": \"{{iSupplierId}}\", // supplier's id\n \"skip\": 0,\n \"limit\": 25,\n \"sortBy\": \"dCreatedDate\",\n \"sortOrder\": \"asc\",\n \"oFilterBy\": {\n \"iEmployeeId\": [],\n \"iWorkstationId\": [],\n \"iBusinessPartnerId\": [\n \"{{iBusinessPartnerId}}\" // business partner's id for supplier\n ],\n \"iBusinessBrandId\": [],\n \"iArticleGroupId\": [],\n \"iLocationId\": [],\n \"aCategory\": []\n },\n \"iBusinessId\": \"{{iBusinessId}}\", // business partner's id for supplier\n \"id\": \"{{iBusinessPartnerId}}\" // business partner's id for supplier\n}","options":{"raw":{"language":"json"}}},"url":"{{cash-register-url}}/api/v1/sales-list/{{iBusinessId}}/supplier","description":"The \"Get Sales List\" API is a pivotal tool within sales and inventory management systems, allowing users to retrieve comprehensive data regarding sales transactions. This API acts as a bridge between the core software application and the database or system business sales data, facilitating seamless access to essential sales details.
\niBusinessId: Own supplier's unique code
\niLocationId: Own supplier's unique location code
\niBusinessPartnerId: The code of the contact document of the 'supplier-store relationship'
\nid: Same as iBusinessPartnerid
\n","urlObject":{"path":["api","v1","sales-list","{{iBusinessId}}","supplier"],"host":["{{cash-register-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"38f6683d-96dd-40bb-8588-9b60e5bb5fcd"}],"id":"edc2adc1-0d36-4914-94cc-fcf4c05ca5a1","description":"Retrieving sales data (sales list) can be done in the same way as how you retrieve inventory data (inventory list)
\nTo get sales data you should call to your microservice: cash register services.
\n","_postman_id":"edc2adc1-0d36-4914-94cc-fcf4c05ca5a1"}],"id":"22754d27-cc0d-4f3a-84c8-ced6256bed67","_postman_id":"22754d27-cc0d-4f3a-84c8-ced6256bed67","description":""},{"name":"Shared Orders (Purchase and Sales)","item":[{"name":"Share an order to a retailer","item":[{"name":"Create Shared Order for the Retailer","id":"a3b41491-778e-46f4-a93c-deef5c79a7cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"iLocationId\": \"{{iLocationId}}\",\n \"iWorkstationId\":\"{{iWorkstationId}}\",\n \"iBusinessPartnerId\": \"{{iBusinessPartnerId}}\",\n \"iBusinessPartnerLocationId\": \"{{iBusinessPartnerLocationId}}\",\n \"iBusinessLocationId\": \"{{iBusinessLocationId}}\",\n \"aItems\": [\n {\n \"productNumber\": \"ProductId 1 Feb added Manually\",\n \"supplierDescription\": \"\",\n \"sellingPrice\": 199,\n \"nVatRate\": 9,\n \"purchasePrice\": 99,\n \"oBusinessBrand\": {},\n \"oArticleGroup\": {},\n \"nQuantity\": 1,\n \"EAN\": \"\",\n \"nMargin\": 1.52,\n \"gift\": false,\n \"ship_cost\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{cash-register-url}}/api/v1/shared-transaction","description":"Create a new Purchase Order for retailers after creating this order you can check this order in the \"purchase-order-retailer\" list.
\n","urlObject":{"path":["api","v1","shared-transaction"],"host":["{{cash-register-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3b41491-778e-46f4-a93c-deef5c79a7cc"}],"id":"c4b68225-199d-483a-8e85-0cebdd7d0477","description":"Create a new Purchase Order for retailers after creating this order you can check this order in the \"purchase-order-retailer\" list.
\n","_postman_id":"c4b68225-199d-483a-8e85-0cebdd7d0477"},{"name":"Shared Sales Order (Shared Transactions)","item":[{"name":"Get Shared Orders List","id":"f2f86a1e-85ea-4813-9bd1-912bca4e4a5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"eType\": \"purchase-order-supplier\"\n}","options":{"raw":{"language":"json"}}},"url":"{{cash-register-url}}/api/v1/shared-transaction/list","description":"Using this API you can get the (purchase) orders list which are shared by retailers to you. Retailers create these orders using the min stock wizard.
\niBusinessId: Own supplier's unique code.
eType: Transaction Type
Just replace the eType value in the request body.
If you are a dealer/supplier then:
\neType: purchase-order-supplier (for purchase orders list)
eType: sales-order (for sales orders list)
Or, if you are a retailer then:
\neType: purchase-order-retailer (for purchase orders list)
It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Transfer-Encoding","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{cash-register-url}}/api/v1/shared-transaction/:transactionId","description":"Find the sales order details using the sales order #ID/transactionId
\niBusinessId: Own supplier's store code.
\niTransactionId: _id of the Sales Order.
\nResponse: After calling this API you got a response like this.
\n{ \n \"sNumber\": \"T0035-050224-1037\",\n \"iBusinessPartnerId\": \"62136d3b4d66e72bd0956878\",\n ...\n}\n\nA unique identifier code assigned to each sale that takes place between a customer and a merchant.
\n","type":"text/plain"},"type":"any","value":"65c1ef231715ff0204fec7ea","key":"transactionId"}]}},"response":[],"_postman_id":"bad7bd2f-0a67-466c-bca1-e4108c6669b7"},{"name":"Get Shared Sales Order with Items Details","id":"6b23f520-1445-44de-b6aa-18def1103797","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{cash-register-url}}/api/v1/shared-transaction/detail/:transactionId?iBusinessId={{iBusinessId}}","description":"Using this API you can find the sales order details with order/transaction items too using the sales order #ID/transactionId
\nNote: Replace \"65c327a562b54942b4043d05\" with your iTransactionId in the request URL
\niBusinessId: Own supplier's store code.
\niTransactionId: _id of the Sales Order.
\nResponse: After calling this API you got the response like this see you got some extra fields there if your account is a Premium account.
\n{ \n \"sNumber\": \"T0035-050224-1037\",\n \"iBusinessPartnerId\": \"62136d3b4d66e72bd0956878\",\n ...\n \"aTransactionItem\": [\n {\n \"sProductNumber\": \"P2351\",\n \"sSupplierProductNumber\": \"P1500/42\", // (for Premium accounts) \n \"iProductId\": \"777888899898885531323\", // (for Premium accounts)\n \"iProductId\": \"633cb8c8adbe49d5883f5e71\",\n \"sEan\": \"8716667171848\",\n \"nQuantity\": 1,\n \"sBaseBrandName\": \"WRSM sieraden\",\n \"sBusinessBrandName\": \"WRSM sieraden\"\n ...\n }\n ]\n}\n\nYour Unique Store Code
\n","type":"text/plain"},"key":"iBusinessId","value":"{{iBusinessId}}"}],"variable":[{"description":{"content":"A unique identifier code assigned to each sale that takes place between a customer and a merchant.
\n","type":"text/plain"},"type":"any","value":"65c327a562b54942b4043d05","key":"transactionId"}]}},"response":[],"_postman_id":"6b23f520-1445-44de-b6aa-18def1103797"}],"id":"7169d1c5-1cb4-4b88-9b05-dd93bd7a0b07","description":"To get sales data that are shared from suppliers to retailers. You should call your microservice: cash register services.
\nYou can pull an order which was created by the retailer from the minimal stock wizard.
\nWe advide NOT to to call this API directly:
\n{{cash-register-url}}/api/v1/shared-transaction/detail/65c327a562b54942b4043d05?iBusinessId={{iBusinessId}}
\nBut rather first use the supplier portal to convert the above order to a 'sales order'. In this way the productnumber changes will be sent back to the retailer portal! So the next time you'll get the products with the correct productnumber!
\nSo instead call this API after the use of the supplier portal:
\n{{cash-register-url}}/api/v1/transaction/detail
\n","_postman_id":"7169d1c5-1cb4-4b88-9b05-dd93bd7a0b07"},{"name":"Sales Orders (Transactions)","item":[{"name":"Get Sales Order List","id":"11f1a058-68ab-4af9-b544-a7c521379b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"iLocationId\": \"{{iLocationId}}\",\n \"eTransactionType\": \"sales-order\",\n \"type\": \"purchaseorder\",\n \"iBusinessPartnerId\": null,\n \"fromPurchaseOrders\": true,\n \"filterDates\": {\n \"endDate\": \"2024-02-04T18:29:59.919Z\",\n \"startDate\": \"2014-12-31T18:30:00.000Z\"\n },\n \"employee\": {\n \"sFirstName\": \"All\"\n },\n \"selectedRepairStatuses\": [],\n \"workstations\": [],\n \"locations\": [],\n \"methods\": [],\n \"TIEKinds\": [],\n \"importStatus\": \"all\",\n \"searchValue\": \"\",\n \"skip\": 0,\n \"limit\": 25\n}","options":{"raw":{"language":"json"}}},"url":"{{cash-register-url}}/api/v1/transaction/list","description":"Using this API you can get the purchase and sales orders list which is shared by suppliers.
\niBusinessId: Own supplier's unique code.
eTransactionType: Transaction Type
Just replace the eTransactionType value in the request body.
If you are a dealer/supplier then:
\neTransactionType: sales-order (for sales orders list)
It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"iTransactionId\": \"65b8e6ca0a4c8d1b9452b58d\"\n}","options":{"raw":{"language":"json"}}},"url":"{{cash-register-url}}/api/v1/transaction/detail","description":"Find the sales order details using the sales order #ID/transactionId
\niBusinessId: Own supplier's store code.
\niTransactionId: _id of the Sales Order.
\n","urlObject":{"path":["api","v1","transaction","detail"],"host":["{{cash-register-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ce53997-b736-4ded-8fef-9d18ab2d7de0"},{"name":"Get Purchase Order List","id":"604b673b-208e-45e5-81c4-2b4c9a4e12d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"type\": \"purchaseorder\",\n \"eTransactionType\": \"purchase-order-supplier\",\n \"iBusinessPartnerId\": null,\n \"fromPurchaseOrders\": true,\n \"filterDates\": {\n \"endDate\": \"2024-02-04T18:29:59.017Z\",\n \"startDate\": \"2014-12-31T18:30:00.000Z\"\n },\n \"employee\": {\n \"sFirstName\": \"All\"\n },\n \"selectedRepairStatuses\": [],\n \"workstations\": [],\n \"locations\": [],\n \"methods\": [],\n \"TIEKinds\": [],\n \"importStatus\": \"all\",\n \"searchValue\": \"\",\n \"skip\": 0,\n \"limit\": 25\n}","options":{"raw":{"language":"json"}}},"url":"{{cash-register-url}}/api/v1/transaction/list","description":"Using this API you can get the purchase orders list which is created by suppliers.
\niBusinessId: Own supplier's unique code.
eTransactionType: Transaction Type
Just replace the eTransactionType value in the request body.
If you are a dealer/supplier then:
\neTransactionType: purchase-order-supplier (for purchase orders list)
Or, if you are a retailer then:
\neTransactionType: purchase-order-retailer (for purchase orders list)
To get sales data you should call to your microservice: cash register services.
Here, query on:
Examples of different transactions:
\nPurchase order: (transaction.eTypeTransaction: 'purchase-order-supplier'
Sales order: (transaction.eTypeTransaction: 'sales-order-supplier'
If your dealer created an order for your company it will appear as:
\nPurchase order: (transaction.eTypeTransaction: 'purchase-order-supplier'
\n","_postman_id":"ebb41e53-42f6-401e-8f2f-d8154518eba1"},{"name":"Orders (Purchase and Sales) Depricated","item":[{"name":"Purchase orders (depricated)","item":[{"name":"Create Order for the Retailer (depricated)","id":"6800965d-36ef-4782-acda-de08a80a9abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"iLocationId\": \"{{iLocationId}}\",\n \"iWorkstationId\":\"{{iWorkstationId}}\",\n \"iBusinessPartnerId\": \"{{iBusinessPartnerId}}\",\n \"iBusinessPartnerLocationId\": \"{{iBusinessPartnerLocationId}}\",\n \"iBusinessLocationId\": \"{{iBusinessLocationId}}\",\n \"aItems\": [\n {\n \"productNumber\": \"ProductId 1 Feb added Manually\",\n \"supplierDescription\": \"\",\n \"sellingPrice\": 199,\n \"nVatRate\": 9,\n \"purchasePrice\": 99,\n \"oBusinessBrand\": {},\n \"oArticleGroup\": {},\n \"nQuantity\": 1,\n \"EAN\": \"\",\n \"nMargin\": 1.52,\n \"gift\": false,\n \"ship_cost\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{cash-register-url}}/api/v1/transaction","description":"Create a new Purchase Order for retailers after creating this order you can check this order in the \"purchase-order-retailer\" list.
\n","urlObject":{"path":["api","v1","transaction"],"host":["{{cash-register-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6800965d-36ef-4782-acda-de08a80a9abb"}],"id":"2e163183-4a14-4806-a0d3-24e0e6827ddd","description":"Create a new Purchase Order for retailers after creating this order you can check this order in the \"purchase-order-retailer\" list.
\n","_postman_id":"2e163183-4a14-4806-a0d3-24e0e6827ddd"}],"id":"7c502503-f797-4007-b627-4c0f9127b822","description":"Examples of different transactions:
\nPurchase order: (transaction.eTypeTransaction: 'purchase-order-supplier'
Sales order: (transaction.eTypeTransaction: 'sales-order-supplier'
If your dealer created an order for your company it will appear as:
\nPurchase order: (transaction.eTypeTransaction: 'purchase-order-supplier'
\n","_postman_id":"7c502503-f797-4007-b627-4c0f9127b822"},{"name":"Products","item":[{"name":"Common mistakes","item":[],"id":"397ca003-04f0-4a93-99c2-998e23354a6d","description":"To create a perfect product management catalog on the platform might be a little bit different than you think initially. Let's start first telling you what not to do and what to do instead.
\nCommon mistakes which create trouble:
\nA. Updating existing products is a far better approach than just 'deleting' all existing base products as this will break all connections towards your dealers products. You need these connections! To make sure you profit from 'data mining' in a later stage. But the most important reason to not directly 'remove products' is that you as a supplier will lose control over the retailer's definition of their products. This will create lot's of problems in taking 'orders' which are created by the retailers. As these ordered products can't be related to your inventory!
\nB. Mixing up EAN numbers and productnumbers which are not related!
This will create a hudge mess into your dealers assortment. Our advice is to remove only the EAN numbers / overwrite EAN numbers and keep the productnumbers the same if they where wrongly added initially. Don't wait to update these products as some dealers will use the EAN number and some will use the productnumber in the 'receiving' process. If you wait to long correcting these EAN/productnumber mistakes this will create the scenario in which shop 1 wants you to update the productNumber and shop 2 wants you to update the EAN number!
C. Reuse EAN numbers from old products and set them on the new delivered products. This might cause problems as your dealers are still having these old products. Problems of mistake B will occur.
\n","_postman_id":"397ca003-04f0-4a93-99c2-998e23354a6d"},{"name":"1. Creating/updating basics","item":[{"name":"Implementing A&B or C","item":[],"id":"bfbb555b-2303-441d-871f-b526fe55d850","description":"In case your product feed does NOT provide information about Stock and B2C Prices we would recommend to implement only 'C. Base product creation/updation'. In case your feed does include stock and price data we highly recommend to implement A&B only.
\n","_postman_id":"bfbb555b-2303-441d-871f-b526fe55d850"},{"name":"A. Business Products","item":[{"name":"Get Business Products List","id":"a4b701ed-69d3-46a1-88fb-79859ba64703","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"skip\": 0,\n \"limit\": 0,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"product\",\n \"aProjection\": [\"_id\",\"iBusinessId\",\"iProductId\",\"iSupplierId\",\"iBusinessBrandId\",\"iBusinessPartnerId\",\"iArticleGroupId\",\"sEan\",\"sProductNumber\",\"sInsertedProductNumber\",\"sLabelDescription\",\"sArticleNumber\",\"nPriceIncludesVat\",\"nPriceVat\",\"nMinStock\",\"nSortingNumber\",\"nDiscount\",\"aImage\",\"oName\",\"oNameSlug\",\"oStock\",\"bDiscountOnPercentage\",\"bShowOnWebBusiness\",\"bBestseller\",\"bHasStock\",\"bEntryMethodCustomerValue\",\"bShowSuggestion\",\"eGender\",\"eOwnerShip\",\"dDateLastPurchased\",\"aProperty\",\"dCreatedDate\",\"dUpdatedDate\"],\n \"oFilterBy\": {\n \"oStatic\": {},\n \"oDynamic\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/products/list","description":"Use this API to Fetch the business product list that the Supplier creates if you don't have any business products you can use this API to create new business product.{{core-url}}/business/products
Use oStatic and oDynamic to apply filters on the business products list.
\n{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"skip\": 0,\n \"limit\": 10,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"product\",\n \"aProjection\": [\"_id\",\"iBusinessId\",\"iProductId\",\"iSupplierId\",\"iBusinessBrandId\",\"iBusinessPartnerId\",\"iArticleGroupId\",\"sEan\",\"sProductNumber\",\"sInsertedProductNumber\",\"sLabelDescription\",\"sArticleNumber\",\"nPriceIncludesVat\",\"nPriceVat\",\"nMinStock\",\"nSortingNumber\",\"nDiscount\",\"aImage\",\"oName\",\"oNameSlug\",\"oStock\",\"bDiscountOnPercentage\",\"bShowOnWebBusiness\",\"bBestseller\",\"bHasStock\",\"bEntryMethodCustomerValue\",\"bShowSuggestion\",\"eGender\",\"eOwnerShip\",\"dDateLastPurchased\",\"aProperty\",\"dCreatedDate\",\"dUpdatedDate\"],\n \"oFilterBy\": {\n \"oStatic\": {\n \"nPriceVat\": [\n \"10\",\n \"100\",\n \"200\"\n ],\n \"sEan\": [\n \"123\"\n ]\n },\n \"oDynamic\": {\n \"60fd97e693dd6f4854ddb9c2\": {\n \"gemCut\": [\n \"sapphire\",\n \"ziracoin\"\n ],\n \"gemColor\": [\n \"black\"\n ]\n }\n }\n }\n}\n\nIt should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","type":"text","description":"Content-Type is define format of body/payload of request
\n"}],"body":{"mode":"raw","raw":"{\n \"sFunctionName\": \"create-business-product\",\n \"nStock\": 0,\n \"nMinStock\": 0,\n \"nSortingNumber\": 0,\n \"bDiscountOnPercentage\": false,\n \"bBestseller\": false,\n \"bShowOnWebShop\": false,\n \"bHasStock\": false,\n \"bEntryMethodCustomerValue\": false,\n \"bShowSuggestion\": false,\n \"aImage\": [],\n \"eOwnerShip\": \"possession\",\n \"iBusinessPartnerId\": \"6275661d5732a79bf0e3f449\",\n \"iArticleGroupId\": \"61f36c0354b06315b4980838\",\n \"sEan\": \"\",\n \"sProductNumber\": \"O111C\",\n \"sLabelDescription\": \"\",\n \"nPurchasePrice\": 1,\n \"nSuggestedRetailPrice\": 1,\n \"nVatRate\": 21,\n \"nPriceIncludesVat\": 1,\n \"oName\": {\n \"en\": \"o111c\"\n },\n \"oNameSlug\": {},\n \"eGender\": \"female\",\n \"dDateLastPurchased\": \"\",\n \"sArticleNumber\": \"\",\n \"business\": {},\n \"aProperty\": [],\n \"aLocation\": [\n {\n \"oAddress\": {\n \"attn\": {\n \"salution\": \"Hon\",\n \"firstName\": \"Jolmer\",\n \"lastNamePrefix\": \"Van\",\n \"lastName\": \"Ekeren\"\n },\n \"street\": \"Middleweg\",\n \"houseNumber\": \"8\",\n \"houseNumberSuffix\": \"B\",\n \"postalCode\": \"1456G\",\n \"city\": \"Asperen\",\n \"country\": \"Holland\",\n \"countryCode\": \"41\",\n \"state\": \"Utrech\"\n },\n \"bIsWebshop\": true,\n \"_id\": \"623b4f531d7d736c686b51f1\",\n \"sName\": \"Webshop\",\n \"nStock\": 0,\n \"nReceivedStock\": 0,\n \"bIsCurrentLocation\": false\n },\n {\n \"bIsWebshop\": false,\n \"_id\": \"623b6d840ed1002890334456\",\n \"sName\": \"Prisma 2\",\n \"nStock\": 0,\n \"nReceivedStock\": 1,\n \"bIsCurrentLocation\": true\n },\n {\n \"bIsWebshop\": false,\n \"_id\": \"623c1f1b6c63de032cfde065\",\n \"sName\": \"Prisma 3\",\n \"nStock\": 0,\n \"nReceivedStock\": 0,\n \"bIsCurrentLocation\": false\n },\n {\n \"bIsWebshop\": false,\n \"_id\": \"623c38f21bc6be308072b103\",\n \"sName\": \"RichRabbit New 1\",\n \"nStock\": 0,\n \"nReceivedStock\": 0,\n \"bIsCurrentLocation\": false\n }\n ],\n \"iBusinessId\": \"6182a52f1949ab0a59ff4e7b\",\n \"iLocationId\": \"623b6d840ed1002890334456\",\n \"isInvoicePriceEditable\": true,\n \"sInsertedProductNumber\": \"\",\n \"oBusinessPartner\": {\n \"_id\": \"6275661d5732a79bf0e3f449\",\n \"oPhone\": {\n \"bWhatsApp\": false\n },\n \"nPurchaseMargin\": 2,\n \"bPreFillCompanySettings\": true,\n \"bEntryMethodCustomerValue\": true,\n \"eFirm\": \"public\",\n \"eAccess\": \"n\",\n \"eStatus\": \"y\",\n \"iBusinessId\": \"6182a52f1949ab0a59ff4e7b\",\n \"sName\": \"Excellent Prisma (Asperen)\",\n \"aBankDetail\": [],\n \"aRetailerComments\": []\n },\n \"oBusinessBrand\": {\n \"sName\": \"\"\n },\n \"oArticleGroup\": {\n \"_id\": \"61f36c0354b06315b4980838\",\n \"bShowInOverview\": false,\n \"bShowOnWebsite\": false,\n \"bInventory\": false,\n \"iBusinessId\": \"6182a52f1949ab0a59ff4e7b\",\n \"sCategory\": \"\",\n \"sSubCategory\": \"\",\n \"oName\": {\n \"en\": \"Prisma Watch\",\n \"nl\": \"Prisma Watch\",\n \"de\": \"Prisma Watch\",\n \"fr\": \"Prisma Watch\",\n \"es\": \"Prisma Watch\"\n },\n \"aProperty\": [\n {\n \"iPropertyId\": \"61160712ae3cbb7453177f98\",\n \"sPropertyName\": \"Category\",\n \"oProperty\": {\n \"STRAP\": \"STRAP\"\n },\n \"sCode\": \"ST\"\n }\n ],\n \"sSearchKeywords\": \"oName.en:Prisma Watch,oName.nl:Prisma Watch,oName.de:Prisma Watch,oName.fr:Prisma Watch,oName.es:Prisma WatchsCode:ST\"\n },\n \"oPaymentDiscount\": {},\n \"nTransactionPurchasePrice\": 1,\n \"isPurchaseOrder\": true,\n \"oExtraData\": {\n \"oOrder\": {\n \"isRetailerPurchaseOrder\": true,\n \"isSupplierPurchaseOrder\": false,\n \"isSalesOrder\": false\n }\n },\n \"oShortDescription\": {},\n \"oLongDescription\": {},\n \"aRequiredFields\": [\n {\n \"section\": \"product-category\",\n \"propertyName\": \"Category\",\n \"propertyId\": \"61160712ae3cbb7453177f98\",\n \"isSet\": false\n },\n {\n \"section\": \"product-category\",\n \"propertyName\": \"Jewelry-type\",\n \"propertyId\": \"627105c6a137e37b7cdcafbe\",\n \"isSet\": true\n },\n {\n \"section\": \"product-web-required-middle\",\n \"propertyName\": \"Size\",\n \"propertyId\": \"626ab0e8a137e37b7cdcadc1\",\n \"isSet\": true\n },\n {\n \"section\": \"product-web-required-middle\",\n \"propertyName\": \"WATCH_STRAP_COLOR\",\n \"propertyId\": \"6262fba225f45755f3d648bb\",\n \"isSet\": true\n },\n {\n \"section\": \"product-web-required-right\",\n \"propertyName\": \"hasDateFunction\",\n \"propertyId\": \"6262ff0d25f45755f3d648cf\",\n \"isSet\": true\n },\n {\n \"section\": \"product-filters-left\",\n \"propertyName\": \"Watch case material\",\n \"propertyId\": \"6261a5f76d3ec230f0886eee\",\n \"isSet\": true\n },\n {\n \"section\": \"product-search-filters-left\",\n \"propertyName\": \"Jewel gloss\",\n \"propertyId\": \"627142c9a137e37b7cdcb06c\",\n \"isSet\": true\n }\n ],\n \"aVariant\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/products","description":"This API will create an entry in the base products catalog only if a iBrandId and sProductNumber are passed. The businessProduct will only be used for your own purpose but baseProduct creation will happen automatically. Please ask the admin which template to use icm accesskeys.
\nNOTE this api contains request paramters to directly define the 'variant'. See section 'Handling sizes/colors (variants)' for more info on this topic.
\nIf you want to create a new product please pass the sFuntionName in the request body:
\n\"sFunctionName\": \"create-business-product\"
{\n \"iBusinessId\": \"\",\n \"iProductId\": \"\",\n \"iSupplier\": \"\",\n \"iShopBrandId\": \"\",\n \"sNameSlug\": \"\",\n \"sSearchKeywords\": \"\",\n \"sEan\": \"\",\n \"sProductNumber\": \"\",\n \"sInsertedProductNumber\": \"\",\n \"sArticleNumber\": \"\",\n \"sLabelDescription\": \"\",\n \"nPurchasePrice\": 0,\n \"nPriceIncludesVat\": 0,\n \"nPriceVat\": 0,\n \"nMinStock\": 0,\n \"nSortingNumber\": 0,\n \"nDiscount\": 0,\n \"bDiscountOnPercentage\": false,\n \"bShowOnWebShop\": false,\n \"bBestseller\": false,\n \"bHasStock\": false,\n \"bEntryMethodCustomerValue\": true,\n \"bShowSuggestion\": false,\n \"aImage\": [],\n \"oName\": {}, // ex: { language: \"name of product\" }\n \"oStock\": {\n \"nPurchased\": 0,\n \"nSold\": 0,\n \"nInventory\": 0,\n \"nImported\": 0,\n },\n \"aVariant\": [\n {\n \"sVariantBase\": \"size\",\n \"aBusinessProduct\": [\n {\n \"iBusinessProductId\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"eGender\": \"male\", // ['male', 'female', 'boy', 'girl', 'unisex'],\n \"eOwnerShip\": \"possession\", // ['possession', 'sight', 'consignment']\n \"eStatus\": \"y\", // ['y', 'n', 'd'],\n \"dDateLastPurchased\": \"\"\n}\n\nIt should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","type":"text","description":"Content-Type is define format of body/payload of request
\n"}],"body":{"mode":"raw","raw":"{\n \"sFunctionName\": \"update-business-product\",\n \"nSuggestedRetailPrice\": 1234566,\n \"aVariant\": [\n {\n \"_id\": \"\",\n \"aBusinessProduct\": [\n {\n \"iBusinessProductId\": \"BP2\",\n \"value\": \"\"\n },\n {\n \"iBusinessProductId\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/products/:iBusinessProductId?iBusinessId={{iBusinessId}}","description":"If you want to test updating your products please pass the sFuntionName in the request body:
\n\"sFunctionName\": \"update-business-product\"
In this case, your updates will not impact the retailer's data directly.
\nTo update the product catalog for all your dealers directly please check the 'Product management' section. It's also possible to let us sync your businessProduct changes to the base products collection. For this, we're able to create a template that will sync your updates automatically to the general catalog. From the general catalog, your dealers are able to retrieve your updates to their products.
\n","urlObject":{"path":["api","v1","business","products",":iBusinessProductId"],"host":["{{core-url}}"],"query":[{"key":"iBusinessId","value":"{{iBusinessId}}"}],"variable":[{"type":"any","value":"iBusinessProductId","key":"iBusinessProductId"}]}},"response":[],"_postman_id":"4c1025bf-1bc9-436d-84e5-e95d4efdd3fd"},{"name":"Delete Business Product","id":"15a81e54-61bb-40c0-910d-a949d9e8be74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","type":"text","description":"Content-Type is define format of body/payload of request
\n"}],"url":"{{core-url}}/api/v1/business/products/:iBusinessProductId","description":"If you want to delete your business product you can use this API to delete product
\n","urlObject":{"path":["api","v1","business","products",":iBusinessProductId"],"host":["{{core-url}}"],"query":[],"variable":[{"type":"any","value":"iBusinessProductId","key":"iBusinessProductId"}]}},"response":[],"_postman_id":"15a81e54-61bb-40c0-910d-a949d9e8be74"},{"name":"Get Business Product Details","id":"3c0da58e-dd7f-44f8-bcaa-cf5895c992a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{core-url}}/api/v1/business/products/:iBusinessProductId","urlObject":{"path":["api","v1","business","products",":iBusinessProductId"],"host":["{{core-url}}"],"query":[],"variable":[{"type":"any","value":"5ade17a71c82dd080e0b0b96","key":"iBusinessProductId"}]}},"response":[],"_postman_id":"3c0da58e-dd7f-44f8-bcaa-cf5895c992a5"},{"name":"Delete Properties of Business Product","id":"4c667937-db92-4152-b015-247e92eb0da8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"url":"{{core-url}}/api/v1/business/product/:iBusinessProductId/property/:iBusinessProductPropertyId","urlObject":{"path":["api","v1","business","product",":iBusinessProductId","property",":iBusinessProductPropertyId"],"host":["{{core-url}}"],"query":[],"variable":[{"type":"any","value":"iBusinessProductId","key":"iBusinessProductId"},{"type":"any","value":"iBusinessProductPropertyId","key":"iBusinessProductPropertyId"}]}},"response":[],"_postman_id":"4c667937-db92-4152-b015-247e92eb0da8"},{"name":"Get Counts for Dynamic Properties","id":"be36a4f2-e778-4ed8-86df-5c6aec59661d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"skip\": 0,\n \"limit\": 12,\n \"searchValue\": \"\",\n \"aProjection\": [\n \"oName\",\n \"_id\",\n \"iBusinessId\",\n \"iProductId\",\n \"iSupplierId\",\n \"iBusinessBrandId\",\n \"iBusinessPartnerId\",\n \"iArticleGroupId\",\n \"sEan\",\n \"sProductNumber\",\n \"sInsertedProductNumber\",\n \"sLabelDescription\",\n \"nPurchasePrice\",\n \"aLocation\",\n \"bDiscountOnPercentage\",\n \"nVatRate\",\n \"nSortingNumber\",\n \"nDiscount\",\n \"aImage\",\n \"sArticleNumber\",\n \"oNameSlug\",\n \"bShowOnWebBusiness\",\n \"bBestseller\",\n \"bHasStock\",\n \"bEntryMethodCustomerValue\",\n \"bShowSuggestion\",\n \"eGender\",\n \"eOwnerShip\",\n \"dDateLastPurchased\",\n \"aProperty\",\n \"dCreatedDate\",\n \"dUpdatedDate\",\n \"bShowOnWebShop\",\n \"dDateLastSold\",\n \"iBusinessProductId\"\n ],\n \"aDynamicProjection\": [],\n \"oFilterBy\": {\n \"oStatic\": {},\n \"aConditionDynamicProperty\": []\n },\n \"aBusinessId\": [\n \"{{iBusinessId}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/products/count-by-dynamic-properties","description":"You can use this API to get counts for the dynamic properties of the business products.
\n","urlObject":{"path":["api","v1","business","products","count-by-dynamic-properties"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be36a4f2-e778-4ed8-86df-5c6aec59661d"},{"name":"Get Counts for Static Properties","id":"b4c1a90a-d031-4409-840b-3e2f17c98104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\",\n \"skip\": 0,\n \"limit\": 12,\n \"searchValue\": \"\",\n \"aProjection\": [\n \"oName\",\n \"_id\",\n \"iBusinessId\",\n \"iProductId\",\n \"iSupplierId\",\n \"iBusinessBrandId\",\n \"iBusinessPartnerId\",\n \"iArticleGroupId\",\n \"sEan\",\n \"sProductNumber\",\n \"sInsertedProductNumber\",\n \"sLabelDescription\",\n \"nPurchasePrice\",\n \"aLocation\",\n \"bDiscountOnPercentage\",\n \"nVatRate\",\n \"nSortingNumber\",\n \"nDiscount\",\n \"aImage\",\n \"sArticleNumber\",\n \"oNameSlug\",\n \"bShowOnWebBusiness\",\n \"bBestseller\",\n \"bHasStock\",\n \"bEntryMethodCustomerValue\",\n \"bShowSuggestion\",\n \"eGender\",\n \"eOwnerShip\",\n \"dDateLastPurchased\",\n \"aProperty\",\n \"dCreatedDate\",\n \"dUpdatedDate\",\n \"bShowOnWebShop\",\n \"dDateLastSold\"\n ],\n \"aDynamicProjection\": [],\n \"oFilterBy\": {\n \"oStatic\": {},\n \"aConditionDynamicProperty\": []\n },\n \"aPropertyName\": [\n \"eGender\",\n \"iLocationId\",\n \"iArticleGroupId\",\n \"iBusinessBrandId\",\n \"iBusinessPartnerId\",\n \"PRODUCT\"\n ],\n \"aBusinessId\": [\n \"{{iBusinessId}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/products/count-by-static-properties","description":"You can use this API to get counts for the static properties of the business products.
\n","urlObject":{"path":["api","v1","business","products","count-by-static-properties"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4c1a90a-d031-4409-840b-3e2f17c98104"},{"name":"List Filters by Applied Filters","id":"6a9808d8-071e-426a-8f5b-cf77eac8cb00","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type is define format of body/payload of request
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aBusinessId\": [],\n \"searchValue\": \"\",\n \"oFilterBy\": {\n \"oStatic\": { },\n \"oDynamic\": {\n \"6114fee95265063b323c0f4d\": { \"color\": [\"black\"] }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business/products/list-filters-by-applied-filters","description":"You can use this API to filter for business products
\n","urlObject":{"path":["api","v1","business","products","list-filters-by-applied-filters"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a9808d8-071e-426a-8f5b-cf77eac8cb00"}],"id":"4ba3c40e-c615-4653-8ed8-557a130212f9","description":"A stock product which belongs to your company/business is called a businessProduct. Pass your businessId to list the products you created.
\nWhen you create a businessProduct passing a iBrandId and sProductNumber. We'll automatically try to create a product in the 'Product catalog' for all your dealers.
\n","_postman_id":"4ba3c40e-c615-4653-8ed8-557a130212f9"},{"name":"B. Stock Correction","item":[{"name":"Create Stock Correction","id":"193837a4-73b3-4ace-b3fb-bc1fa8ffaa66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","type":"text","description":"Content-Type is define format of body/payload of request
\n"}],"url":"{{core-url}}/api/v1/stock/stockCorrection/:iActivityId","description":"You can use this API to create new stock corrections.
\n","urlObject":{"path":["api","v1","stock","stockCorrection",":iActivityId"],"host":["{{core-url}}"],"query":[],"variable":[{"type":"any","value":"iActivityId","key":"iActivityId"}]}},"response":[],"_postman_id":"193837a4-73b3-4ace-b3fb-bc1fa8ffaa66"}],"id":"cef459db-d482-48db-8a88-3094d6c0d0ff","description":"To update the stock you should use a seperate API to do so. In this way the stock changing history is proper maintained and purchase price value's proper calculated.
\n","_postman_id":"cef459db-d482-48db-8a88-3094d6c0d0ff"},{"name":"C. Base product create/update","item":[{"name":"create product (step 1)","id":"83758acf-e428-4a99-bbe0-9881aa92faa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"create product","description":"Which information can be added while 'creating' a product? Below an overview of required, adviced, other details to add.
\nFor the below properties. Take a look at: Add properties
\nAfter you integrated the create product call use your supplier portal to perform step 2! See the steps to take above the create product api.
\n","urlObject":{"host":["create product"],"query":[],"variable":[]}},"response":[],"_postman_id":"83758acf-e428-4a99-bbe0-9881aa92faa1"},{"name":"update product (step 3)","id":"3613cd2f-d109-4a4a-8b14-d48c89e91859","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"update product","urlObject":{"host":["update product"],"query":[],"variable":[]}},"response":[],"_postman_id":"3613cd2f-d109-4a4a-8b14-d48c89e91859"}],"id":"e6bac915-3c94-49a2-bf32-c3a04c05f711","description":"If your feed also contains stocks/purchase prices we advice to use 'business products' APIs. Look at the 'A. business products' section! Payloads are same so in case you integrated this API just call the 'business-products' create, update routes
\n","_postman_id":"e6bac915-3c94-49a2-bf32-c3a04c05f711"}],"id":"f55e6a93-7acc-4a4c-8b68-c5bdcbcf84ea","description":"Follow these steps to maintain a proper product catalog:
\n1* Note: your merges will impact ALL your dealers product information. Handle this function with care.
2*Note: Never change an EAN number after usage.
Before you start implementing step 1. Please read the next chapter on 'Higher level: Product catalog maitaining base on suppliers data'
\n","_postman_id":"f55e6a93-7acc-4a4c-8b68-c5bdcbcf84ea"},{"name":"2. Properties adding","item":[{"name":"Properties","item":[{"name":"Get Properties List","id":"05f002fc-a40e-4896-b5ea-21e684490a2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","type":"text","description":"Content-Type is define format of body/payload of request
\n"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iLocationId}}\",\n \"skip\": 0,\n \"limit\": 100,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/properties/list","description":"{\noFilterBy: {}\n}
\n","urlObject":{"path":["api","v1","properties","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[{"id":"2d654747-7319-4c8d-8d26-065834ddff2a","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"organization-id","value":"blurrybon","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/properties/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"397"},{"key":"accept-ranges","value":"bytes"},{"key":"Date","value":"Mon, 05 Jul 2021 12:12:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"oParentField\": {\n \"sName\": \"test1\",\n \"sValue\": \"test1\"\n },\n \"aOptions\": [\n \"test\"\n ],\n \"_id\": \"60e2f65060c3fc3a0e6288b2\",\n \"sName\": \"test\",\n \"sFunctionName\": \"test\",\n \"sPlaceholder\": \"test\",\n \"sDataBaseFieldName\": \"test\",\n \"sTooltip\": \"test\",\n \"bEnableGrouping\": true,\n \"bReadOnly\": true,\n \"bSetTranslations\": true,\n \"bRequired\": true,\n \"value\": \"test\",\n \"eFormField\": \"input\",\n \"eInputType\": \"text\",\n \"eRole\": \"retailer\"\n }\n ]\n}"},{"id":"40774443-506e-4485-a24c-5b97bc17cea1","name":"401","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorization}}","type":"text","disabled":true},{"key":"organization-id","value":"blurrybon","type":"text"}],"url":"{{core-url}}/properties/list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"organization-id, authorization, verification server-token"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"70"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Sun, 11 Jul 2021 15:48:59 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authentication Error, Please try logging again\",\n \"data\": {}\n}"}],"_postman_id":"05f002fc-a40e-4896-b5ea-21e684490a2f"},{"name":"Get Property Details","id":"aa383a2f-87ae-4b68-9ddf-6689fbba7243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests
\n"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key
\n"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key
\n"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code
\n"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code
\n"},{"key":"Content-Type","value":"application/json","type":"text","description":"Content-Type is define format of body/payload of request
\n"}],"url":"{{core-url}}/api/v1/properties/:propertyId","description":"You can use this API to find property details for the business product.
\n","urlObject":{"path":["api","v1","properties",":propertyId"],"host":["{{core-url}}"],"query":[],"variable":[{"type":"any","value":"propertyId","key":"propertyId"}]}},"response":[{"id":"29669aca-5493-4edf-b9c8-92ae38946a41","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text","description":"It should always be \"x-access-key\" for all requests"},{"key":"x-access-key","value":"{{accessKey}}","type":"text","description":"Your Access Key"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text","description":"Your Secret Key of an Access Key"},{"key":"organization-id","value":"{{organizationId}}","type":"text","description":"Your Organization Code"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text","description":"Your Unique Store Code"},{"key":"Content-Type","value":"application/json","type":"text","description":"Content-Type is define format of body/payload of request"}],"url":{"raw":"{{core-url}}/api/v1/properties/:propertyId","host":["{{core-url}}"],"path":["api","v1","properties",":propertyId"],"variable":[{"key":"propertyId","value":"6115001ebb93c43d17d83722"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 Feb 2024 11:54:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"439"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"organization-id, authorization, verification server-token"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": {\n \"_id\": \"60eab0ec7c2c572456c7d17c\",\n \"sName\": \"test5\",\n \"sPlaceholder\": \"test\",\n \"sDataBaseFieldName\": \"test\",\n \"sTooltip\": \"test\",\n \"bEnableGrouping\": true,\n \"bReadOnly\": true,\n \"bSetTranslations\": true,\n \"bRequired\": true,\n \"value\": \"test\",\n \"oParentField\": {\n \"sName\": \"test1\",\n \"sValue\": \"test1\"\n },\n \"aOptions\": [\n {\n \"_id\": \"60eab0ec7c2c572456c7d17d\",\n \"sKey\": \"test\",\n \"sValue\": \"test\"\n }\n ],\n \"eFormField\": \"input\",\n \"eInputType\": \"text\",\n \"eRole\": \"retailer\"\n }\n}"}],"_postman_id":"aa383a2f-87ae-4b68-9ddf-6689fbba7243"}],"id":"95282a69-1c6a-407e-866e-74f7bfb714c4","_postman_id":"95282a69-1c6a-407e-866e-74f7bfb714c4","description":""},{"name":"remove property from product","item":[{"name":"delete image from product","id":"b5129faf-b21b-4193-a7ee-8e013c2c1b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b5129faf-b21b-4193-a7ee-8e013c2c1b2e"}],"id":"ef4a95da-59d7-4f1f-89d3-3084b651bbad","description":"To remove a property from a product it's possible to overwrite it with 'null' or a different value. But for properties which are saved in an array like the product.aImages you may not want to overwrite. For these purposes we do have an API to delete a specific array object (image in this case)
\n","_postman_id":"ef4a95da-59d7-4f1f-89d3-3084b651bbad"}],"id":"b8e8034d-1c07-409e-9fcd-143f6edabf5a","description":"To add properties you need to save a iPropertyId and iPropertyOptionId to select property (Category, Material etc.) and the respective options: (Watch, Titanium)
\nYou can use these API's to fetch the options from which you can choose
\n","_postman_id":"b8e8034d-1c07-409e-9fcd-143f6edabf5a"},{"name":"3. Stock and purchase price and salesprice data","item":[{"name":"Enable dropshipping (show on webshop)","item":[{"name":"validate business product show on web shop flag","id":"13d36f9a-533d-4eb2-b628-846d15e65ec4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"6182a52f1949ab0a59ff4e7b\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/general/validate-business-product-show-on-web-shop-flag","description":"You can use this command to put all products on the webshop. Before this api puts your products online it will check wether all required details are added so the product shows proper and the filters are correct.
\n","urlObject":{"path":["api","v1","general","validate-business-product-show-on-web-shop-flag"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"13d36f9a-533d-4eb2-b628-846d15e65ec4"}],"id":"26efb566-26f7-4bb8-8af1-1b670bf296c2","description":"Use the below api to check the products which are available on the webshop to true.
\n","_postman_id":"26efb566-26f7-4bb8-8af1-1b670bf296c2"}],"id":"45edca1a-4f5e-4a3f-b846-122aca377760","description":"Benefit of adding stock & price data and create businessProducts even if you're not using it for your companies inventory management:
\nA. You avoid your dealers ordering 'products' which are not in stock at your side
\nIn some cases your dealers will create a order based on their 'minimal stock levels'. By indicating which products are in-stock/ out-of-stock these will be excluded when generating the order. This function can be used by your sales representatives aswell.
\nB. Make sure your dealers can 'dropship' your products.
\nYour businessProducts will be shown on your dealers website. Only products which are available will be shown
\n","_postman_id":"45edca1a-4f5e-4a3f-b846-122aca377760"},{"name":"4. Handling sizes/colors (variants)","item":[{"name":"business products variant","item":[{"name":"list business products","id":"bea94d21-0590-4274-a35f-9d532d55d8f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"{{iBusinessId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1//business-product-variants/list","description":"{\n \"iShopId\": \"all\",\n \"skip\": 0,\n \"limit\": 10,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"product\",\n \"oFilterBy\": {\n \"oStatic\": {\n \"nPriceVat\": [\"10\", \"100\", \"200\"],\n \"sEan\": [\"123\"]\n },\n \"oDynamic\": {\n \"60fd97e693dd6f4854ddb9c2\": { \"gemCut\": [\"sapphire\", \"ziracoin\"], \"gemColor\": [\"black\"] }\n }\n }\n}
\n","urlObject":{"path":["api","v1","","business-product-variants","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bea94d21-0590-4274-a35f-9d532d55d8f4"},{"name":"create business products","id":"69f5f47d-7ea2-4e84-bb4a-32ebe891eb5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"6182a52f1949ab0a59ff4e7b\",\n \"sVariantBase\": \"size\",\n \"iBusinessProductId\": \"625832d60a0831b2bcb7229c\",\n \"aBusinessProduct\": [\n {\n \"iBusinessProductId\": \"622b5b735289a15f2813c87b\",\n \"value\": 30\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/business-product-variants","description":"{
iShopId: mongoose.Schema.Types.ObjectId, // required
iProductId: mongoose.Schema.Types.ObjectId,
iSupplier: mongoose.Schema.Types.ObjectId, // required
iShopBrandId: mongoose.Schema.Types.ObjectId,
sNameSlug: { type: String }
sSearchKeywords: { type: String }
sEan: { type: String },
sProductNumber: { type: String }, // required
sInsertedProductNumber: { type: String }, // required
sArticleNumber: { type: String }
sLabelDescription: { type: String },
nPurchasePrice: { type: Number },
nPriceIncludesVat: { type: Number }, // required
nPriceVat: { type: Number, default: 0 }, // required
nMinStock: { type: Number, default: 0 },
nSortingNumber: { type: Number, default: 0 },
nDiscount: { type: Number, default: 0 },
bDiscountOnPercentage: { type: Boolean, default: false },
bShowOnWebShop: { type: Boolean, default: false },
bBestseller: { type: Boolean, default: false },
bHasStock: { type: Boolean, default: false },
bEntryMethodCustomerValue: { type: Boolean, default: true },
bShowSuggestion: { type: Boolean, default: false },
aImage: [String], // \"url;alt\"
oName: {}, // required //ex: { language: \"name of product\" }
oStock: {
nPurchased: { type: Number, default: 0 },
nSold: { type: Number, default: 0 },
nInventory: { type: Number, default: 0 },
nImported: { type: Number, default: 0 },
},
\"aVariant\": [ { \"sVariantBase\": \"size\", \"aBusinessProduct\": [ { \"iBusinessProductId\": \"\", \"value\": \"\" } ] } ],
eGender: {
/** TODO => User as a property as well */
type: String,
enum: ['male', 'female', 'boy', 'girl', 'unisex'],
},
eOwnerShip: {
type: String,
enum: ['possession', 'sight', 'consignment'],
default: 'possession',
},
eStatus: {
type: String,
enum: ['y', 'n', 'd'],
default: 'y',
},
dDateLastPurchased: { type: Date },
},
'iProductId' /* removable only /,
'iSupplierId' / editable only /,
'iShopBrandId' / editable only /,
'sNameSlug' / editable only /,
'sEan' / editable, removable /,
'sProductNumber' / editable /,
'sLabelDescription' / editable, removable /,
'nPurchasePrice' / editable /,
'nPriceIncludesVat' / editable /,
'nPriceVat' / editable /,
'nMinStock' / editable /,
'nSortingNumber' / editable /,
'nDiscount' / editable /,
'aImage' / editable, removable : replace root array /,
'oName' / editable /,
'bDiscountOnPercentage' / editable /,
'bBestseller' / editable /,
'bHasStock' / editable /,
'bEntryMethodCustomerValue' / editable /,
'bShowSuggestion' / editable /,
'oStock' / editable /,
'eGender' / editable /,
'eOwnerShip' / editable /,
'dDateLastPurchased' / editable */,
\"aVariant\": [ { \"_id\": \"\", \"aBusinessProduct\": [ { \"iBusinessProductId\": \"\", \"value\": \"\" } ] } ]
\n","urlObject":{"path":["api","v1","business-product-variants",":id"],"host":["{{core-url}}"],"query":[],"variable":[{"id":"ec31c7f2-c5a9-4140-b39c-f28682d7297f","type":"any","value":"62977f32d3f70d0a76d5df4c","key":"id"}]}},"response":[],"_postman_id":"bccab941-004c-4d4a-8e1a-28b72d2a058c"},{"name":"delete business products","id":"a3a50bf9-ba76-4c81-bb10-b74de27858fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/business-product-variants/:id","urlObject":{"path":["api","v1","business-product-variants",":id"],"host":["{{core-url}}"],"query":[],"variable":[{"id":"8a3be00e-4049-48d3-92d1-539227ec07f9","type":"any","value":"60fd976f93dd6f4854ddb9bd","key":"id"}]}},"response":[],"_postman_id":"a3a50bf9-ba76-4c81-bb10-b74de27858fe"},{"name":"get business products","id":"724bad39-f265-4cf2-a9b7-920fc78043c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/business-product-variants/:id","urlObject":{"path":["api","v1","business-product-variants",":id"],"host":["{{core-url}}"],"query":[],"variable":[{"id":"8496b5c3-c707-464c-a86a-4b5d8f72e82e","type":"any","value":"6151871527dba32eb4c0c87d","key":"id"}]}},"response":[],"_postman_id":"724bad39-f265-4cf2-a9b7-920fc78043c6"}],"id":"ea0e69f9-1ffe-4ced-8326-4e7930046e89","_postman_id":"ea0e69f9-1ffe-4ced-8326-4e7930046e89","description":""}],"id":"c42124ba-19b2-4f7d-a458-1eee95214d0b","description":"To proper handle variant sizes / variant colors we created a mechanism for B2B use and B2C use to define the wished sizes/colors/materials on a product.
\nNote: sizes variants can be used in the advicing flow helping your dealers to decrease their stock value.
\nThere are two ways of handling variants.
\nUsually the first option is used in a more professional wholesales environment. Having a seperate productnumber per size/color/material.
\nVariants can be used in an advanced manner creating a purchase order proposal wizard which advices to purchase specific variants only! In this case you're allowing the dealer not to buy 'all' sizes but only those how are the most common to sell. A good method to keep their investments in your products effective!
\n","_postman_id":"c42124ba-19b2-4f7d-a458-1eee95214d0b"},{"name":"5. Advising dealers to purchase goods","item":[{"name":"client-groups","item":[{"name":"list clientgroup","id":"720ead2e-993c-45c1-98bf-7d69dd9bd1f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/client-groups/list","urlObject":{"path":["api","v1","client-groups","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"720ead2e-993c-45c1-98bf-7d69dd9bd1f4"},{"name":"create clientgroup","id":"0cf9a4f6-ce7e-47f0-aee0-b48a8e6cad8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/client-groups/create","urlObject":{"path":["api","v1","client-groups","create"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0cf9a4f6-ce7e-47f0-aee0-b48a8e6cad8e"},{"name":"get clientgroup","id":"a2435100-104a-438b-82cb-667cd05081b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/client-groups/:iClientGroupId","urlObject":{"path":["api","v1","client-groups",":iClientGroupId"],"host":["{{core-url}}"],"query":[],"variable":[{"id":"b84cbe15-0656-4075-ae88-de94a9fcf9d2","type":"any","value":null,"key":"iClientGroupId"}]}},"response":[],"_postman_id":"a2435100-104a-438b-82cb-667cd05081b3"},{"name":"update clientgroup","id":"f0722c2d-ea5b-45bc-ab88-f8ad739e527a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/client-groups/update","urlObject":{"path":["api","v1","client-groups","update"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0722c2d-ea5b-45bc-ab88-f8ad739e527a"},{"name":"delete clientgroup","id":"0d3cdedb-96fc-4696-8e72-9f036d1d9516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/client-groups/:iClientGroupId","urlObject":{"path":["api","v1","client-groups",":iClientGroupId"],"host":["{{core-url}}"],"query":[],"variable":[{"id":"f1a63372-d2d7-4432-85ee-09f1232ff918","type":"any","value":null,"key":"iClientGroupId"}]}},"response":[],"_postman_id":"0d3cdedb-96fc-4696-8e72-9f036d1d9516"}],"id":"d1edf85f-465d-4dbc-bb71-998d79a4e8be","description":"If you have no idea about how to divide your shops simply create only one clientgroup. Client groups can also be created via the supplier panel.
\n","_postman_id":"d1edf85f-465d-4dbc-bb71-998d79a4e8be"},{"name":"adviced-products","item":[{"name":"create adviced product","id":"9cbf6347-8376-4389-b38d-85d4b8976ac0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/adviced-products/","urlObject":{"path":["api","v1","adviced-products",""],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cbf6347-8376-4389-b38d-85d4b8976ac0"},{"name":"list adviced products","id":"2c9a3fce-70fb-4ced-bceb-c78c2ca7f602","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{core-url}}/api/v1/adviced-products/list","urlObject":{"path":["api","v1","adviced-products","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c9a3fce-70fb-4ced-bceb-c78c2ca7f602"}],"id":"0e9e66f7-8441-4533-8f97-8f6244a14e29","description":"Note: to advice a retailer what he should purchase you need to have at least one clientgroup. See the above api for that.
\nAdviced can also be created via the supplier panel manually for a demo or test. If you want to create adviced products based on your ERP data please use this api for it.
\n","_postman_id":"0e9e66f7-8441-4533-8f97-8f6244a14e29"}],"id":"05b4a9fe-aadb-4a27-ae42-b51cc7919a61","description":"You can create a list of 'Adviced products' for your dealers. This list is viewable for your dealers in their account and is used to help them purchase the right products from your company. Use the api below to advice your retailers to purchase these products. Combining both your and your dealers data sources into one wizard.
\nAn adviced product can be adviced to multiple shops at the same time. For this you need to create a division of stores by putting every store into a 'client group'.
\nLet your sales representatives mark 'related products'. We'll map the adviced products which are related to others so a dealer can 'explore' the new collections.
\nExplore functionality for retailers
\nNote: your merges will impact ALL your dealers product information. Handle this function with care!
\nchosenBaseProductId: this product will be replaced or updated.
\nsearchedBaseProductId: this product will be the source of the new product details. It will be kept as the original product.
\n","urlObject":{"path":["api","v1","general","merge","products"],"host":["{{core-url}}"],"query":[{"disabled":true,"key":"test","value":null}],"variable":[]}},"response":[],"_postman_id":"54b9e4a4-e92d-4db8-838f-f5345e5ac2cb"},{"name":"import products","id":"1d159883-631e-41e2-ac90-66b3cd9fca90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"iBusinessId\": \"61a8e2d184c3acd1f95f5bb8\",\n \"sDefaultLanguage\": \"en\",\n \"sFunctionName\": \"purchaseOrder\",\n \"oTemplate\": {\n \"nPriceIncludesVat\": \"do-nothing\",\n \"nMinStock\": \"do-nothing\",\n \"oName\": \"do-nothing\",\n \"bShowSuggestion\": \"do-nothing\",\n \"bEntryMethodCustomerValue\": \"do-nothing\",\n \"sProductNumber\": \"do-nothing\",\n \"iBusinessBrandId\": \"do-nothing\",\n \"iSupplier\": \"do-nothing\",\n \"sEan\": \"do-nothing\",\n \"nPriceVat\": \"do-nothing\",\n \"nDiscount\": \"do-nothing\",\n \"bBestseller\": \"do-nothing\",\n \"aImage\": \"do-nothing\",\n \"bDiscountOnPercentage\": \"do-nothing\",\n \"eOwnerShip\": \"do-nothing\",\n \"sLabelDescription\": \"do-nothing\",\n \"nSortingNumber\": \"do-nothing\",\n \"eGender\": \"do-nothing\",\n \"oNameSlug\": \"do-nothing\",\n \"nPurchasePrice\": \"do-nothing\",\n \"bHasStock\": \"do-nothing\"\n },\n \"aProduct\": [\n {\n \"Brand\": \"CASIO\",\n \"Article group\": \"Casio stalenband\",\n \"Supplier\": \"Casio Benelux B.V.\",\n \"Ean\": \"4780260000000\",\n \"Product number\": \"KA1013542\",\n \"Label Description\": \"AMORIO VRIENDSCHAPSRINGEN\",\n \"ArticleNumber\": \"51875\",\n \"Purchase price\": \"9.95\",\n \"Selling price incl VAT\": \"24.95\",\n \"Vat\": \"21\",\n \"Min stock\": \"10\",\n \"Sorting number\": \"5612000\",\n \"discount\": \"10\",\n \"image 0\": \"fgwua-580-25-x1_200x200.webp\",\n \"nl Product name\": \"Van Schaik\",\n \"en Product name\": \"Van Schaik\",\n \"nl Product name slug\": \"van-schaik\",\n \"en Product name slug\": \"van-schaik\",\n \"Discount on percentage\": \"true\",\n \"show on webshop\": \"true\",\n \"bestseller\": \"false\",\n \"Has stock\": \"true\",\n \"Entry method customer value\": \"true\",\n \"Show suggestion\": \"false\",\n \"gender\": \"male\",\n \"Ownership\": \"possession\",\n \"Last Purchase Order Date\": \"\",\n \"iBusinessBrandId\": \"61a93ab784c3acd1f95f5c82\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/general/import/products","description":"{\n \"skip\": 0,\n \"limit\": 1,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": { key: value } // any root property\n}
\n","urlObject":{"path":["api","v1","general","import","products"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d159883-631e-41e2-ac90-66b3cd9fca90"},{"name":"import products Copy","id":"00adec9a-61f2-4f82-8cac-56a58c246981","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-type","value":"x-access-key","type":"text"},{"key":"x-access-key","value":"{{accessKey}}","type":"text"},{"key":"x-secret-key","value":"{{secretKey}}","type":"text"},{"key":"organization-id","value":"{{organizationId}}","type":"text"},{"key":"iBusinessId","value":"{{iBusinessId}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"limit\": 500,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": {\n \"oStatic\": {},\n \"oDynamic\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{core-url}}/api/v1/product/list","description":"{\n \"skip\": 0,\n \"limit\": 1,\n \"sortBy\": \"\",\n \"sortOrder\": \"\",\n \"searchValue\": \"\",\n \"oFilterBy\": { key: value } // any root property\n}
\n","urlObject":{"path":["api","v1","product","list"],"host":["{{core-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00adec9a-61f2-4f82-8cac-56a58c246981"}],"id":"1605ba12-458c-4a1b-89f0-5b9de841f7c8","description":"To get clean sales-list and stocklist data from your dealers. It's efficient to make sure you data is correct added to the product catalog. Everyone is able create products in the base products collection. In case duplicates in the base products database are created. As a company you can initiate to concat those two products together.
\nYou can pass two product._id's in this function and everyone will start using the 'concatted' product after your merging action.
\n","_postman_id":"1605ba12-458c-4a1b-89f0-5b9de841f7c8"}],"id":"07010fae-dfa5-432c-a344-6b2c051ede1e","description":"If you want to create products we advice to study the chapters: 1-3 before you start to create products.
\n","_postman_id":"07010fae-dfa5-432c-a344-6b2c051ede1e"}],"variable":[{"key":"auth-url","value":"https://auth.1-retailgear.org"}]}