{"info":{"_postman_id":"b6f99448-355b-4b4c-8016-2c1753f7c0cc","name":"Product Catalog - External API","description":"

Product Catalog Service - External API

\n

This collection provides the external API endpoints for the Product Catalog using system user (service account) authentication via the e-Agora platform.

\n

Getting Started

\n

1. Authentication

\n

Use the Sign In (System User) request to obtain an access token using client_credentials. The token is automatically saved and injected into all subsequent product requests.

\n

2. Product Operations

\n

Once authenticated, you can:

\n\n

Variables

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
VariableDescription
baseUrlBase URL of the e-Agora platform
client_idService account client ID
client_secretService account client secret
accessTokenAuto-populated after sign-in
productGtinGTIN of the product to get/update
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Product Catalog Service - External API","slug":"product-catalog-service-external-api"}],"owner":"52934370","collectionId":"b6f99448-355b-4b4c-8016-2c1753f7c0cc","publishedId":"2sBXqDs3So","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-17T16:06:31.000Z"},"item":[{"name":"Authentication","item":[{"name":"Sign In (System User)","event":[{"listen":"test","script":{"exec":["pm.test('Status is 200 OK', () => {"," pm.response.to.have.status(200);","});","","pm.test('Access token is returned and saved', () => {"," const body = pm.response.json();"," const token = body.access_token || body.accessToken || body.token;"," pm.expect(token, 'Token should be present in response').to.exist;",""," pm.collectionVariables.set('accessToken', token);"," console.log('Access token saved successfully');","});"],"type":"text/javascript","id":"1ed78947-ee8a-413f-9d1b-d06e135b4560"}}],"id":"567914e6-ce13-4625-a0c1-959445c4c438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"response_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"","type":"text"},{"key":"client_secret","value":"","type":"text"}]},"url":"https://e-agora.equadis.com/api/signin","description":"

Authenticate using a service account (client credentials) on the ea-backend service.

\n

Request body (form-data):

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
response_typestringMust be client_credentials
client_idstringYour service account ID (e.g. SA1234)
client_secretstringYour service account secret
\n

Response: Returns an access token that is automatically saved to the accessToken collection variable.

\n","urlObject":{"path":["api","signin"],"host":["https://e-agora.equadis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"567914e6-ce13-4625-a0c1-959445c4c438"}],"id":"3214997f-ba6d-43a3-b797-c2793cb1c3f9","description":"

Authenticate as a system user (service account) using client credentials on the ea-backend service.

\n

Run the Sign In request first — the access token is automatically saved and used by all product requests.

\n","_postman_id":"3214997f-ba6d-43a3-b797-c2793cb1c3f9"},{"name":"Products","item":[{"name":"Create Product","event":[{"listen":"test","script":{"exec":["pm.test('Status is 201 Created', () => {"," pm.response.to.have.status(201);","});"],"type":"text/javascript","packages":{},"requests":{},"id":"ff6d7220-0ea3-4859-9ccc-3a007721d371"}},{"listen":"prerequest","script":{"exec":[],"type":"text/javascript","id":"86162aac-d6dd-4206-8541-2aa3d716b461"}}],"id":"e9f996f2-9c9f-4e73-8a97-df35fc0eef86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"gtin\": \" (required)\",\n \"categoryId\": \" (required)\",\n \"fields\": [\n {\n \"fieldId\": \"\",\n \"label\": \"\",\n \"value\": [\n {\n \"country\": [\"\"],\n \"retailer\": [\"\"],\n \"allRecipients\": \"\",\n \"language\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"fieldId\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"label\": \"\",\n \"value\": [\"\", \"\"]\n }\n ],\n \"picturesUrl\": [\"\"],\n \"characteristics\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://e-agora.equadis.com/api/external/products","description":"

Create a new product in the catalog.

\n

Required fields:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
gtinstringGlobal Trade Item Number (must be unique)
categoryIdUUIDProduct category ID
fieldsarray of FieldValueDtoProduct field values (at least one required)
\n

Optional fields:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
picturesUrlarray of stringImage URLs (processed server-side)
picturesarray of ProductImageDtoProduct images
characteristicsarray of KeyValueDtoProduct characteristics (key-value pairs)
\n

FieldValueDto:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
fieldIdstring (UUID)Field identifier
labelstringField label
valueobjectField value (varies by type, see examples below)
\n

Field value types:

\n
    \n
  • TEXT (language-scoped): { \"fieldId\": \"...\", \"label\": \"...\", \"value\": [{ \"country\": [], \"retailer\": [], \"allRecipients\": true, \"language\": \"fr\", \"value\": \"text\" }] }
    • \n
  • SINGLE_SELECT: { \"fieldId\": \"...\", \"label\": \"...\", \"value\": \"OptionValue\" }
    • \n
  • MULTI_SELECT: { \"fieldId\": \"...\", \"label\": \"...\", \"value\": [\"Option1\", \"Option2\"] }
    • \n
\n

ProductImageDto:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
countryarray of stringCountries this image applies to
retailerarray of stringRetailers this image applies to
allRecipientsbooleanTrue if image applies to all recipients
imageIdUUIDImage identifier
mainbooleanWhether this is the main image
validityStartDatedatetimeImage validity start
validityEndDatedatetimeImage validity end
valuearray of UUIDImage resource IDs
\n

Response: 201 Created (empty body).

\n

Error responses:

\n
    \n
  • 400 — Validation errors (missing mandatory fields, invalid dropdown values, duplicate GTIN)
    • \n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"85deefdc-1113-45d4-888f-82e19b6120ba","id":"85deefdc-1113-45d4-888f-82e19b6120ba","name":"Products","type":"folder"}},"urlObject":{"path":["api","external","products"],"host":["https://e-agora.equadis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9f996f2-9c9f-4e73-8a97-df35fc0eef86"},{"name":"Get Product by GTIN","event":[{"listen":"test","script":{"exec":["pm.test('Status is 200 OK', () => {"," pm.response.to.have.status(200);","});","","pm.test('Response contains product data', () => {"," const body = pm.response.json();"," pm.expect(body.gtin).to.exist;","});"],"type":"text/javascript","id":"aa4b12d6-0220-4304-8cb1-4d39421a3911"}}],"id":"b1535400-8d80-4fff-9e93-92f4b58019d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://e-agora.equadis.com/api/external/products/","description":"

Retrieve a product by its GTIN.

\n

Path parameter:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
productGtinstringThe product's Global Trade Item Number
\n

Response: 200 OK with ProductExternalDto:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
categoryIdUUIDProduct category ID
gtinstringGlobal Trade Item Number
picturesarray of ProductImageDtoProduct images
fieldsarray of FieldValueDtoProduct field values
characteristicsarray of KeyValueDtoProduct characteristics
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"85deefdc-1113-45d4-888f-82e19b6120ba","id":"85deefdc-1113-45d4-888f-82e19b6120ba","name":"Products","type":"folder"}},"urlObject":{"path":["api","external","products",""],"host":["https://e-agora.equadis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1535400-8d80-4fff-9e93-92f4b58019d5"},{"name":"Update Product by GTIN","event":[{"listen":"test","script":{"exec":["pm.test('Status is 204 No Content', () => {"," pm.response.to.have.status(204);","});"],"type":"text/javascript","packages":{},"requests":{},"id":"3bb17169-2207-4c12-a99d-d2b26ab1011b"}},{"listen":"prerequest","script":{"exec":[],"type":"text/javascript","id":"220559b4-0286-4818-99f8-a8e1e0a1ae97"}}],"id":"019aa5db-ff4e-4881-9355-4a402c9cd5e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields\": [\n {\n \"fieldId\": \"\",\n \"label\": \"\",\n \"value\": [\n {\n \"country\": [\"\"],\n \"retailer\": [\"\"],\n \"allRecipients\": \"\",\n \"language\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"fieldId\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"label\": \"\",\n \"value\": [\"\", \"\"]\n }\n ],\n \"picturesUrl\": [\"\"],\n \"characteristics\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://e-agora.equadis.com/api/external/products/","description":"

Update an existing product by its GTIN.

\n

Path parameter:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
productGtinstringThe product's Global Trade Item Number
\n

Required fields:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
fieldsarrayProduct field values (at least one required)
\n

Optional fields:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
categoryIdUUIDProduct category ID
picturesarrayProduct images
characteristicsarrayProduct characteristics
\n

Notes:

\n
    \n
  • gtin cannot be changed (it is used as the identifier in the path)
    • \n
  • Omitted fields are preserved from the existing product (patch semantics)
    • \n
  • Mandatory field validation is NOT enforced on update
    • \n
\n

Response: 204 No Content on success.

\n

Error responses:

\n
    \n
  • 400 — Validation errors (invalid dropdown values)
    • \n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"85deefdc-1113-45d4-888f-82e19b6120ba","id":"85deefdc-1113-45d4-888f-82e19b6120ba","name":"Products","type":"folder"}},"urlObject":{"path":["api","external","products",""],"host":["https://e-agora.equadis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"019aa5db-ff4e-4881-9355-4a402c9cd5e5"}],"id":"85deefdc-1113-45d4-888f-82e19b6120ba","description":"

Product operations via the product-catalog-service external API (/external/products).

\n

All requests in this folder use Bearer token authentication — run Sign In first.

\n

Important: The external API identifies products by GTIN (not UUID).

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"_postman_id":"85deefdc-1113-45d4-888f-82e19b6120ba"}],"variable":[{"key":"baseUrl","value":"https://e-agora.equadis.com","type":"string","description":"Base URL of the e-Agora platform"},{"key":"accessToken","value":"","type":"string","description":"Bearer token (auto-populated after sign-in)"},{"key":"productGtin","value":"","type":"string","description":"GTIN of the product (used for get/update)"},{"key":"client_id","value":"","type":"string","description":"Service account client ID"},{"key":"client_secret","value":"","type":"string","description":"Service account client secret"}]}