{ "opencollection": "1.0.0", "info": { "name": "Opply Activity Feed Companies API", "version": "0.0.0" }, "items": [ { "info": { "name": "Companies", "type": "folder" }, "items": [ { "info": { "name": "api_v1_companies_documents_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/documents/", "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_documents_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/documents/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_companies_documents_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/documents/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_companies_documents_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/companies/documents/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Request a resumable file upload URL", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/documents/:uuid/create-resumable-upload-session/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Request a resumable file upload URL" }, { "info": { "name": "Set an upload as done", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/documents/:uuid/upload-complete/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Set an upload as done" }, { "info": { "name": "List brands associated with Merchant of Record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-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." }, { "name": "search", "value": "", "type": "query", "description": "Filter brands by name (case-insensitive partial match)" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve a list of brand companies where the current user's company serves as the Merchant of Record." }, { "info": { "name": "Create a new buyer/brand", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new buyer/brand company with associated user and address" }, { "info": { "name": "Get buyer/brand details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve detailed information about a buyer/brand company" }, { "info": { "name": "Update buyer/brand details", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Partially update buyer/brand company information. User email cannot be changed after creation." }, { "info": { "name": "List compliance documents held by this buyer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/compliance-documents/", "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." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the buyer's certification/compliance documents (sales tax exemption certificates, organic/quality certifications, etc.) with their lifecycle status and free-text notes. Documents filed by the onboarding extraction agent also carry a structured `extraction` object (jurisdiction, certificate number, issuing authority); manually uploaded documents have `extraction: null`. Read-only; ordered newest-first." }, { "info": { "name": "Connect buyer to Allianz", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/connect-allianz/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Validate the given Allianz company ID against the Allianz API and, on success, persist allianz_company_id and is_connected_to_allianz=True on the buyer. Set skip_validation=true to bypass the API call (for local/staging environments)." }, { "info": { "name": "List financial documents uploaded by this buyer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/financial-documents/", "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." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the financial documents (P&L, balance sheet, management accounts, etc.) the buyer has uploaded to support credit reviews. Read-only; ordered newest-first." }, { "info": { "name": "Manage Buyer/Brand details for Merchant of Record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/onboarding-suppliers/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for MoR users to view, create, and update buyer/brand details and their suppliers" }, { "info": { "name": "Get suppliers for a buyer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/suppliers/", "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." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a list of suppliers associated with this buyer" }, { "info": { "name": "Add a user to a buyer/brand", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-buyers/:uuid/users/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an additional user on an existing buyer company scoped to the requesting MoR. The user is created without a password and emailed a set-password link once the transaction commits: buyers still onboarding (`onboarding_state=in_progress`) receive the buyer-onboarding invite whose link points at the buyer web app; active buyers receive the standard password-create email. Pass `is_admin=true` to grant the new user the company admin permission; otherwise they join as a member." }, { "info": { "name": "List company addresses by company UUID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-company-addresses/", "params": [ { "name": "address_type", "value": "", "type": "query", "description": "Optional address-type filter (e.g. 'delivery_address' for delivery pickers)" }, { "name": "company_uuid", "value": "", "type": "query", "description": "UUID of the company to filter addresses by" }, { "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": "ViewSet for retrieving and creating company addresses filtered by company UUID.\nIntended for use by Merchant of Record users." }, { "info": { "name": "Create a new company address for a given company UUID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-company-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for retrieving and creating company addresses filtered by company UUID.\nIntended for use by Merchant of Record users." }, { "info": { "name": "Manage company addresses filtered by Merchant of Record", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-company-addresses/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for retrieving and creating company addresses filtered by company UUID.\nIntended for use by Merchant of Record users." }, { "info": { "name": "Manage company addresses filtered by Merchant of Record", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-company-addresses/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for retrieving and creating company addresses filtered by company UUID.\nIntended for use by Merchant of Record users." }, { "info": { "name": "Manage company addresses filtered by Merchant of Record", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-company-addresses/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "ViewSet for retrieving and creating company addresses filtered by company UUID.\nIntended for use by Merchant of Record users." }, { "info": { "name": "List suppliers associated with Merchant of Record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/", "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." }, { "name": "search", "value": "", "type": "query", "description": "Filter suppliers by name (case-insensitive partial match)" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve a list of supplier companies where the current user's company serves as the Merchant of Record." }, { "info": { "name": "Get supplier basic information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve supplier details for a given company UUID." }, { "info": { "name": "Add buyer to supplier", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/add-buyer/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add a new buyer to this supplier by creating a referral relationship" }, { "info": { "name": "Get buyer-supplier payment terms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/buyer-payment-terms/", "params": [ { "name": "buyer_uuid", "value": "", "type": "query", "description": "UUID of the buyer company" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lookup payment terms for a buyer-supplier pair. Returns 204 No Content if none set." }, { "info": { "name": "Create buyer-supplier payment terms", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/buyer-payment-terms/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create payment terms for a buyer-supplier pair. Returns 400 if terms already exist." }, { "info": { "name": "Update buyer-supplier payment terms", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/buyer-payment-terms/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Partially update payment terms for a buyer-supplier pair." }, { "info": { "name": "Delete buyer-supplier payment terms", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/buyer-payment-terms/", "params": [ { "name": "buyer_uuid", "value": "", "type": "query", "description": "UUID of the buyer company" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Remove payment terms for a buyer-supplier pair." }, { "info": { "name": "Get buyers for supplier", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/buyers/", "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." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a list of buyers (brands) associated with this supplier through referrals" }, { "info": { "name": "List supplier contacts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/contacts/", "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." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List all contacts for this supplier." }, { "info": { "name": "Create supplier contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/contacts/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new supplier contact." }, { "info": { "name": "Replace supplier contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/contacts/:contact_uuid/", "params": [ { "name": "contact_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Full update (replace) of a supplier contact." }, { "info": { "name": "Partially update supplier contact", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/contacts/:contact_uuid/", "params": [ { "name": "contact_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Partial update of a supplier contact." }, { "info": { "name": "Delete supplier contact", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/contacts/:contact_uuid/", "params": [ { "name": "contact_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a supplier contact." }, { "info": { "name": "Get supplier payout details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/payout-details/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve payout details for this supplier." }, { "info": { "name": "Create supplier payout details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/payout-details/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create payout details for this supplier. Only one record is allowed per supplier." }, { "info": { "name": "Update supplier payout details", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/payout-details/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Partially update payout details for this supplier." }, { "info": { "name": "Delete supplier payout details", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/payout-details/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete payout details for this supplier." }, { "info": { "name": "Remove buyer from supplier", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/remove-buyer/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Remove a buyer from this supplier by deleting the referral relationship" }, { "info": { "name": "List supplier sites", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/sites/", "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." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List sites for this supplier." }, { "info": { "name": "Create supplier site", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/sites/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new site for this supplier." }, { "info": { "name": "Update supplier payout information", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/update/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update supplier payout terms and days until payout due." }, { "info": { "name": "Update supplier buyers", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/companies/merchant-of-record-suppliers/:uuid/update-buyers/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update the complete list of buyers for this supplier" } ] } ], "bundled": true }