{ "opencollection": "1.0.0", "info": { "name": "Opply Activity Feed Catalog API", "version": "0.0.0" }, "items": [ { "info": { "name": "Catalog", "type": "folder" }, "items": [ { "info": { "name": "Merchant of Record buyer item endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/", "params": [ { "name": "buyer_company", "value": "", "type": "query" }, { "name": "category", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "kind", "value": "", "type": "query", "description": "What kind of material this row represents (ingredient, packaging, ...).\n\n* `ingredient` - Ingredient\n* `packaging` - Packaging" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record buyer item endpoints", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record buyer item endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record buyer item endpoints", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record buyer item endpoints", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record buyer item endpoints", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "List documents for a buyer item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/:uuid/documents/", "params": [ { "name": "buyer_company", "value": "", "type": "query" }, { "name": "category", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "kind", "value": "", "type": "query", "description": "What kind of material this row represents (ingredient, packaging, ...).\n\n* `ingredient` - Ingredient\n* `packaging` - Packaging" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Upload a document for a buyer item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/:uuid/documents/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Delete a document for a buyer item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/catalog/buyer-items/:uuid/documents/:document_uuid/", "params": [ { "name": "document_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage buyer catalogue items.\n\nFlat resource at /api/v1/catalog/buyer-items/.\nFilter by buyer_company, is_active, category via query params." }, { "info": { "name": "Brand-facing catalog item endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/items/", "params": [ { "name": "buyer_company", "value": "", "type": "query" }, { "name": "category", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "kind", "value": "", "type": "query", "description": "What kind of material this row represents (ingredient, packaging, ...).\n\n* `ingredient` - Ingredient\n* `packaging` - Packaging" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Brand-facing CRUD for the buyer's own catalogue items (materials).\n\nFlat resource at /api/v1/catalog/items/. Scoped to the authenticated\nuser's company via `request.user_company`." }, { "info": { "name": "Brand-facing catalog item endpoints", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/catalog/items/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Brand-facing CRUD for the buyer's own catalogue items (materials).\n\nFlat resource at /api/v1/catalog/items/. Scoped to the authenticated\nuser's company via `request.user_company`." }, { "info": { "name": "Brand-facing catalog item endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Brand-facing CRUD for the buyer's own catalogue items (materials).\n\nFlat resource at /api/v1/catalog/items/. Scoped to the authenticated\nuser's company via `request.user_company`." }, { "info": { "name": "Brand-facing catalog item endpoints", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/catalog/items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Brand-facing CRUD for the buyer's own catalogue items (materials).\n\nFlat resource at /api/v1/catalog/items/. Scoped to the authenticated\nuser's company via `request.user_company`." }, { "info": { "name": "Brand-facing catalog item endpoints", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/catalog/items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Brand-facing CRUD for the buyer's own catalogue items (materials).\n\nFlat resource at /api/v1/catalog/items/. Scoped to the authenticated\nuser's company via `request.user_company`." }, { "info": { "name": "Brand-facing catalog item endpoints", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/catalog/items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Brand-facing CRUD for the buyer's own catalogue items (materials).\n\nFlat resource at /api/v1/catalog/items/. Scoped to the authenticated\nuser's company via `request.user_company`." }, { "info": { "name": "Merchant of Record supplier item endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/", "params": [ { "name": "category", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "kind", "value": "", "type": "query", "description": "What kind of material this row represents (ingredient, packaging, ...).\n\n* `ingredient` - Ingredient\n* `packaging` - Packaging" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "supplier_company", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record supplier item endpoints", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record supplier item endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record supplier item endpoints", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record supplier item endpoints", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "Merchant of Record supplier item endpoints", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "List documents for a supplier item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/:uuid/documents/", "params": [ { "name": "category", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "kind", "value": "", "type": "query", "description": "What kind of material this row represents (ingredient, packaging, ...).\n\n* `ingredient` - Ingredient\n* `packaging` - Packaging" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "supplier_company", "value": "", "type": "query" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "Upload a document for a supplier item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/:uuid/documents/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." }, { "info": { "name": "Delete a document for a supplier item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/catalog/supplier-items/:uuid/documents/:document_uuid/", "params": [ { "name": "document_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to manage supplier catalogue items.\n\nFlat resource at /api/v1/catalog/supplier-items/.\nFilter by supplier_company, is_active, category via query params." } ] } ], "bundled": true }