Skip to content

Update Akeneo PIM API.postman_collection.json#1216

Open
hemm00 wants to merge 1 commit into
masterfrom
updated_postman_collection
Open

Update Akeneo PIM API.postman_collection.json#1216
hemm00 wants to merge 1 commit into
masterfrom
updated_postman_collection

Conversation

@hemm00

@hemm00 hemm00 commented Apr 1, 2026

Copy link
Copy Markdown

Summary

Comprehensive quality pass on the Akeneo PIM API Postman collection — fixing functional bugs, aligning with official documentation, and restructuring for discoverability.

Changes

Bug fixes (functional)

  • Auth variables: {{basicAuthUsername}}/{{basicAuthPassword}}{{clientId}}/{{secret}} to match collection-level variable definitions
  • Prerequest script: pm.environment.get/setpm.collectionVariables.get/set so auto-auth works without a separate Postman environment
  • Hardcoded credentials: Replaced "admin"/"admin" in auth body with {{username}}/{{password}} variables
  • Product media file upload: Fixed formdata file field from type: "text"type: "file"
  • Submit draft body: Made all 3 "Submit a draft for approval" requests (Product identifier, UUID, Product model) consistent — body, headers, and structure now match
  • Typo: "occured""occurred" in prerequest script error message

Response example corrections

  • 6 endpoints with empty-body 200 responses corrected to 204 No Content (Extensions update, job launches, mapping schema update, workflow task update) — confirmed against docs
  • Added Location header to 7 201 Created responses that were missing it (catalogs, extensions, draft submissions, data architect agent)

Directory restructure (docs-aligned)

Reorganized from a flat list of 38 folders into 9 top-level groups matching the official API reference:

Group Subfolders
Products Product [uuid], Product [identifier], Product model, Product media file
Jobs Jobs
Catalog structure Family, Family variant, Attribute, Attribute option, Attribute group, Association type, Category
Utilities Authentication, Overview, System, Rule definition, Permissions, Extensions, Data Architect Agent
Target market settings Channel, Locale, Currency, Measurement family
Reference entities Reference entity, Reference entity attribute, Reference entity attribute option, Reference entity record, Reference entity media file
Asset Manager Asset family, Asset attribute, Asset attribute option, Asset media file, Asset
Catalogs for Apps Catalogs, Catalog products, Mapping schema for products
Workflows Workflows, Workflow executions, Workflow tasks

What was intentionally NOT changed

  • Endpoint names left as-is (verified against docs — naming varies by section intentionally)
  • HTTP methods left as-is (e.g. "Update a UI extension with file upload" is POST per docs)
  • All 150 requests and their URLs, query params, test scripts, and JSON schemas preserved

## Summary

Comprehensive quality pass on the Akeneo PIM API Postman collection — fixing functional bugs, aligning with official documentation, and restructuring for discoverability.

## Changes

### Bug fixes (functional)
- **Auth variables**: `{{basicAuthUsername}}`/`{{basicAuthPassword}}` → `{{clientId}}`/`{{secret}}` to match collection-level variable definitions
- **Prerequest script**: `pm.environment.get/set` → `pm.collectionVariables.get/set` so auto-auth works without a separate Postman environment
- **Hardcoded credentials**: Replaced `"admin"/"admin"` in auth body with `{{username}}`/`{{password}}` variables
- **Product media file upload**: Fixed formdata `file` field from `type: "text"` → `type: "file"`
- **Submit draft body**: Made all 3 "Submit a draft for approval" requests (Product identifier, UUID, Product model) consistent — body, headers, and structure now match
- **Typo**: `"occured"` → `"occurred"` in prerequest script error message

### Response example corrections
- 6 endpoints with empty-body 200 responses corrected to **204 No Content** (Extensions update, job launches, mapping schema update, workflow task update) — confirmed against docs
- Added **Location header** to 7 `201 Created` responses that were missing it (catalogs, extensions, draft submissions, data architect agent)

### Directory restructure (docs-aligned)
Reorganized from a flat list of 38 folders into 9 top-level groups matching the [official API reference](https://api.akeneo.com/api-reference-index.html):

| Group | Subfolders |
|---|---|
| Products | Product [uuid], Product [identifier], Product model, Product media file |
| Jobs | Jobs |
| Catalog structure | Family, Family variant, Attribute, Attribute option, Attribute group, Association type, Category |
| Utilities | Authentication, Overview, System, Rule definition, Permissions, Extensions, Data Architect Agent |
| Target market settings | Channel, Locale, Currency, Measurement family |
| Reference entities | Reference entity, Reference entity attribute, Reference entity attribute option, Reference entity record, Reference entity media file |
| Asset Manager | Asset family, Asset attribute, Asset attribute option, Asset media file, Asset |
| Catalogs for Apps | Catalogs, Catalog products, Mapping schema for products |
| Workflows | Workflows, Workflow executions, Workflow tasks |

### What was intentionally NOT changed
- Endpoint names left as-is (verified against docs — naming varies by section intentionally)
- HTTP methods left as-is (e.g. "Update a UI extension with file upload" is POST per docs)
- All 150 requests and their URLs, query params, test scripts, and JSON schemas preserved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant