{ "opencollection": "1.0.0", "info": { "name": "Opply Activity Feed Public Buyer Onboarding API", "version": "0.0.0" }, "items": [ { "info": { "name": "Public Buyer Onboarding", "type": "folder" }, "items": [ { "info": { "name": "Get buyer onboarding details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get buyer onboarding details including country information." }, { "info": { "name": "Get account details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/account-details/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get account details for this buyer." }, { "info": { "name": "Create account details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/account-details/create/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create account details for this buyer. Can only be created once." }, { "info": { "name": "Update account details", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/account-details/update/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update account details for this buyer." }, { "info": { "name": "Get delivery addresses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-addresses/", "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 all delivery addresses for the buyer onboarding." }, { "info": { "name": "Delete delivery address", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-addresses/:address_uuid/delete/", "params": [ { "name": "address_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a delivery address by UUID." }, { "info": { "name": "Update delivery address", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-addresses/:address_uuid/update/", "params": [ { "name": "address_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update an existing delivery address by UUID." }, { "info": { "name": "Create delivery address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-addresses/create/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new delivery address for the buyer onboarding." }, { "info": { "name": "Get delivery details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-details/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get delivery details for this buyer." }, { "info": { "name": "Create delivery details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-details/create/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create delivery details for this buyer. Can only be created once." }, { "info": { "name": "Update delivery details", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-details/update/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update delivery details for this buyer." }, { "info": { "name": "Get or update delivery emails", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-emails/", "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: Get all delivery emails for the buyer onboarding.\n\nPOST: Create or update delivery emails. Accepts an object with 'delivery_emails' array. If UUID is provided and exists, the email will be updated. If UUID is not provided or doesn't exist, a new email will be created. Emails not in the payload will be deleted." }, { "info": { "name": "Get or update delivery emails", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/delivery-emails/", "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" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "GET: Get all delivery emails for the buyer onboarding.\n\nPOST: Create or update delivery emails. Accepts an object with 'delivery_emails' array. If UUID is provided and exists, the email will be updated. If UUID is not provided or doesn't exist, a new email will be created. Emails not in the payload will be deleted." }, { "info": { "name": "List documents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/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": "Get all documents for the buyer onboarding." }, { "info": { "name": "Delete document", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/documents/:document_uuid/delete/", "params": [ { "name": "document_uuid", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a document by UUID." }, { "info": { "name": "Upload document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/documents/upload/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload a document for the buyer onboarding." }, { "info": { "name": "Get onboarding phases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/phases/", "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 all available onboarding phases with their step templates." }, { "info": { "name": "List buyer onboarding steps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/steps/", "params": [ { "name": "is_completed", "value": "", "type": "query", "description": "Filter by completion status (true/false)" }, { "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": "phase", "value": "", "type": "query", "description": "Filter by phase (phase_1, phase_2, phase_3, phase_4)" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all onboarding steps for this buyer, organized by phase." }, { "info": { "name": "Get buyer onboarding step", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/steps/:step_id/", "params": [ { "name": "step_id", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get details of a specific onboarding step." }, { "info": { "name": "List suppliers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/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 all suppliers for this buyer." }, { "info": { "name": "Get supplier details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/suppliers/:supplier_id/", "params": [ { "name": "supplier_id", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get details of a specific supplier." }, { "info": { "name": "Update supplier", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/suppliers/:supplier_id/update/", "params": [ { "name": "supplier_id", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a supplier for this buyer." }, { "info": { "name": "Mark supplier section as complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/suppliers/complete/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Mark the supplier section as complete for this buyer." }, { "info": { "name": "Create supplier", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/buyer-onboarding/public/buyers/:uuid/suppliers/create/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new supplier for this buyer." } ] } ], "bundled": true }