{ "opencollection": "1.0.0", "info": { "name": "Opply Activity Feed Brands API", "version": "0.0.0" }, "items": [ { "info": { "name": "Brands", "type": "folder" }, "items": [ { "info": { "name": "List companies the current user can act on", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/accessible/me/", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the set of companies the authenticated user can target in API calls.\n\n- Staff users: marker response indicating \"all\" — no list is returned.\n- Merchant of Record users: their managed companies plus their own.\n- Brand (buyer) and Supplier users: their own company only.\n\nUsed by the MCP `list_accessible_companies` tool. Also useful for any client\nthat needs to render a company-picker scoped to the user's permissions." }, { "info": { "name": "Company address endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/addresses/", "params": [ { "name": "address_type", "value": "", "type": "query", "description": "Supported address types: billing_address delivery_address dispatch_address company_address." }, { "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." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Company address endpoints" }, { "info": { "name": "Company address endpoints", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Company address endpoints" }, { "info": { "name": "Company address endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Company address endpoints" }, { "info": { "name": "Company address endpoints", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/companies/addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Company address endpoints" }, { "info": { "name": "Company address endpoints", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Company address endpoints" }, { "info": { "name": "Company address endpoints", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/companies/addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Company address endpoints" }, { "info": { "name": "api_v1_companies_brands_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/brands/", "params": [ { "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." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_companies_brands_my_suppliers_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/brands/:brand_uuid/my-suppliers/", "params": [ { "name": "brand_uuid", "value": "", "type": "path" }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "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" } } }, { "info": { "name": "api_v1_companies_brands_my_suppliers_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/brands/:brand_uuid/my-suppliers/:referred_company__uuid/", "params": [ { "name": "brand_uuid", "value": "", "type": "path" }, { "name": "referred_company__uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_companies_brands_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/brands/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_companies_brands_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/companies/brands/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_companies_brands_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/brands/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Acknowledge marketplace T&Cs for the current brand company.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/brands/acknowledge-marketplace-terms-and-conditions/", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Acknowledge the current marketplace T&C version for the brand company.\n\nAcknowledgement mechanics (version stamping, audit row, idempotency,\nbackfilled-row upgrade) live in\n``apps.companies.services.marketplace_terms`` — shared with\n``CompanyInfoViewSet.finish_onboarding``." }, { "info": { "name": "Dashboard counts for Brands.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/brands/dashboard/count/", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Dashboard counts for Brands." }, { "info": { "name": "api_v1_companies_brands_mor_kyb_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/brands/mor-kyb-status/", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Basic info of a company", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/info/", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Basic info of a company" }, { "info": { "name": "Send company invite endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/invite-company/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send company invite endpoint" }, { "info": { "name": "Mark the current company's buyer onboarding as complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/me/finish-onboarding/", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Flips `Company.onboarding_state` from `in_progress` to `active`, unlocking the rest of the buyer app. Idempotent in spirit: a company that is already `active` (or any other non-`in_progress` state) returns 409 so the caller can recover without firing a duplicate side-effect." }, { "info": { "name": "api_v1_companies_onboarding_brand_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/onboarding/brand/", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "api_v1_inquiries_quotes_brand_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "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." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Retrieve details of a quote for a brand", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve details of a quote for a brand" }, { "info": { "name": "Endpoint for manage quote samples", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Endpoint for manage quote samples" }, { "info": { "name": "api_v1_inquiries_quotes_brand_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Endpoint to cancel purchase request for a contract for Buyer.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/cancel-purchase-request/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Endpoint to cancel purchase request for a contract for Buyer." }, { "info": { "name": "api_v1_inquiries_quotes_brand_channel_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/channel/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_inquiries_quotes_brand_decline_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/decline/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Endpoint to request contract extension for Buyer.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/extend-contract/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Endpoint to request contract extension for Buyer." }, { "info": { "name": "api_v1_inquiries_quotes_brand_mark_contract_proceeded_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/mark-contract-proceeded/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_inquiries_quotes_brand_mark_proceeded_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/mark-proceeded/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Request update to expired quote https://app.clickup.com/t/8695a05f2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/:uuid/request-update/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Request update to expired quote https://app.clickup.com/t/8695a05f2" }, { "info": { "name": "Retrieve the quote for a purchase inquiry taking its UUID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/:inquiry_uuid/quotes/brand/purchase_request_quote/", "params": [ { "name": "inquiry_uuid", "value": "", "type": "path" }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "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." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve the quote for a purchase inquiry taking its UUID" } ] } ], "bundled": true }