Opply Admin panel API
The Admin panel API from Opply — 46 operation(s) for admin panel.
The Admin panel API from Opply — 46 operation(s) for admin panel.
openapi: 3.0.3
info:
title: Opply Activity Feed Admin panel API
version: 0.0.0
tags:
- name: Admin panel
paths:
/api/v1/users/admin_panel/companies/:
get:
operationId: api_v1_users_admin_panel_companies_list
parameters:
- in: query
name: company_type
schema:
type: string
enum:
- brand
- merchant_of_record
- supplier
description: '* `brand` - Brand
* `supplier` - Supplier
* `merchant_of_record` - Merchant of Record'
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: search
schema:
type: string
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAdminCompanyList'
description: ''
/api/v1/users/admin_panel/companies/{company_uuid}/company_documents/:
get:
operationId: api_v1_users_admin_panel_companies_company_documents_list
summary: Company documents for admin
parameters:
- in: path
name: company_uuid
schema:
type: string
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAdminCompanyDocumentList'
description: ''
post:
operationId: api_v1_users_admin_panel_companies_company_documents_create
summary: Company documents for admin
parameters:
- in: path
name: company_uuid
schema:
type: string
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdminCompanyDocument'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AdminCompanyDocument'
multipart/form-data:
schema:
$ref: '#/components/schemas/AdminCompanyDocument'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'201':
description: No response body
/api/v1/users/admin_panel/companies/{company_uuid}/company_documents/{uuid}/:
get:
operationId: api_v1_users_admin_panel_companies_company_documents_retrieve
summary: Company documents for admin
parameters:
- in: path
name: company_uuid
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdminCompanyDocument'
description: ''
delete:
operationId: api_v1_users_admin_panel_companies_company_documents_destroy
summary: Company documents for admin
parameters:
- in: path
name: company_uuid
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'204':
description: No response body
/api/v1/users/admin_panel/companies/{company_uuid}/company_documents/send-uploaded-list-notification/:
post:
operationId: api_v1_users_admin_panel_companies_company_documents_send_uploaded_list_notification_create
summary: Endpoint to send email notification of uploaded products or ingredients list
parameters:
- in: path
name: company_uuid
schema:
type: string
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdminSendUploadedListEmailNotification'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AdminSendUploadedListEmailNotification'
multipart/form-data:
schema:
$ref: '#/components/schemas/AdminSendUploadedListEmailNotification'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
description: No response body
/api/v1/users/admin_panel/companies/{company_uuid}/existing-suppliers/:
get:
operationId: api_v1_users_admin_panel_companies_existing_suppliers_list
summary: Existing supplier admin endpoint
parameters:
- in: path
name: company_uuid
schema:
type: string
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedExistingSuppliersListList'
description: ''
/api/v1/users/admin_panel/companies/{uuid}/:
get:
operationId: api_v1_users_admin_panel_companies_retrieve
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdminCompanyRetrieve'
description: ''
/api/v1/users/admin_panel/companies/{uuid}/assign-inquiry/:
post:
operationId: api_v1_users_admin_panel_companies_assign_inquiry_create
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryTargetCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/InquiryTargetCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/InquiryTargetCreate'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryTargetCreate'
description: ''
/api/v1/users/admin_panel/companies/{uuid}/buyer-summary/:
post:
operationId: api_v1_users_admin_panel_companies_buyer_summary_create
summary: Endpoint to fill buyer summary for suppliers
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdminBuyerSummary'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AdminBuyerSummary'
multipart/form-data:
schema:
$ref: '#/components/schemas/AdminBuyerSummary'
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdminBuyerSummary'
description: ''
/api/v1/users/admin_panel/companies/{uuid}/catalogues/:
get:
operationId: api_v1_users_admin_panel_companies_catalogues_retrieve
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdminProductCatalogueList'
description: ''
/api/v1/users/admin_panel/companies/{uuid}/employees/:
get:
operationId: api_v1_users_admin_panel_companies_employees_list
parameters:
- in: query
name: company_type
schema:
type: string
enum:
- brand
- merchant_of_record
- supplier
description: '* `brand` - Brand
* `supplier` - Supplier
* `merchant_of_record` - Merchant of Record'
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: search
schema:
type: string
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCompanyUserAdminList'
description: ''
/api/v1/users/admin_panel/companies/{uuid}/inquiries/:
get:
operationId: api_v1_users_admin_panel_companies_inquiries_retrieve
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyInquiryAdmin'
description: ''
/api/v1/users/admin_panel/companies/check-referral-code/:
post:
operationId: api_v1_users_admin_panel_companies_check_referral_code_create
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdminCheckReferralCode'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AdminCheckReferralCode'
multipart/form-data:
schema:
$ref: '#/components/schemas/AdminCheckReferralCode'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdminCompanyRetrieve'
description: ''
/api/v1/users/admin_panel/company_address/:
get:
operationId: api_v1_users_admin_panel_company_address_list
summary: Company address endpoints
parameters:
- in: query
name: address_type
schema:
type: string
description: 'Supported address types: billing_address delivery_address dispatch_address company_address.'
- in: query
name: company_uuid
schema:
type: string
format: uuid
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCompanyAddressList'
description: ''
post:
operationId: api_v1_users_admin_panel_company_address_create
summary: Company address endpoints
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyAddressAdminCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CompanyAddressAdminCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/CompanyAddressAdminCreate'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyAddressAdminCreate'
description: ''
/api/v1/users/admin_panel/company_address/{uuid}/:
get:
operationId: api_v1_users_admin_panel_company_address_retrieve
summary: Company address endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyAddress'
description: ''
put:
operationId: api_v1_users_admin_panel_company_address_update
summary: Company address endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyAddress'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CompanyAddress'
multipart/form-data:
schema:
$ref: '#/components/schemas/CompanyAddress'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyAddress'
description: ''
patch:
operationId: api_v1_users_admin_panel_company_address_partial_update
summary: Company address endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCompanyAddress'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCompanyAddress'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCompanyAddress'
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyAddress'
description: ''
delete:
operationId: api_v1_users_admin_panel_company_address_destroy
summary: Company address endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'204':
description: No response body
/api/v1/users/admin_panel/create_brand/:
post:
operationId: api_v1_users_admin_panel_create_brand_create
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrandCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BrandCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/BrandCreate'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrandCreate'
description: ''
/api/v1/users/admin_panel/create_supplier/:
post:
operationId: api_v1_users_admin_panel_create_supplier_create
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SupplierCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/SupplierCreate'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierCreate'
description: ''
/api/v1/users/admin_panel/get_temporary_token/:
post:
operationId: api_v1_users_admin_panel_get_temporary_token_create
summary: get temporary token for masquerade mode
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserTokenRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UserTokenRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/UserTokenRequest'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserTokenResponse'
description: ''
'400':
description: No response body
/api/v1/users/admin_panel/get_token/:
post:
operationId: api_v1_users_admin_panel_get_token_create
summary: get real user token for masquerade mode
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserTokenResponse'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UserTokenResponse'
multipart/form-data:
schema:
$ref: '#/components/schemas/UserTokenResponse'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserTokenResponse'
description: ''
/api/v1/users/admin_panel/ingredients/:
get:
operationId: api_v1_users_admin_panel_ingredients_list
summary: Ingredients admin endpoint
parameters:
- in: query
name: company_uuid
schema:
type: string
format: uuid
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAdminIngredientResponseList'
description: ''
/api/v1/users/admin_panel/inquiries/:
get:
operationId: api_v1_users_admin_panel_inquiries_list
summary: Inquiry admin endpoints
parameters:
- in: query
name: brand_uuid
schema:
type: string
format: uuid
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: published_exists
schema:
type: boolean
- in: query
name: search
schema:
type: string
- in: query
name: state
schema:
type: string
enum:
- awaiting_quotes
- cancelled
- contract_confirmed
- expired
- ordered
- proceeded
- quotes_available
- supplier_decline_to_quote
description: '* `awaiting_quotes` - Awaiting Quotes
* `quotes_available` - Quotes Available
* `ordered` - Ordered
* `expired` - Expired
* `proceeded` - Proceeded
* `contract_confirmed` - Contract Confirmed
* `supplier_decline_to_quote` - Supplier Decline To Quote
* `cancelled` - Cancelled'
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedInquiryAdminList'
description: ''
post:
operationId: api_v1_users_admin_panel_inquiries_create
summary: Inquiry admin endpoints
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryCreateAdmin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/InquiryCreateAdmin'
multipart/form-data:
schema:
$ref: '#/components/schemas/InquiryCreateAdmin'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryCreateAdmin'
description: ''
/api/v1/users/admin_panel/inquiries/{inquiry_uuid}/documents/:
get:
operationId: api_v1_users_admin_panel_inquiries_documents_list
summary: Inquiry document
parameters:
- in: path
name: inquiry_uuid
schema:
type: string
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedInquiryDocumentList'
description: ''
/api/v1/users/admin_panel/inquiries/{inquiry_uuid}/documents/{uuid}/:
get:
operationId: api_v1_users_admin_panel_inquiries_documents_retrieve
summary: Inquiry document
parameters:
- in: path
name: inquiry_uuid
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryDocument'
description: ''
/api/v1/users/admin_panel/inquiries/{uuid}/:
get:
operationId: api_v1_users_admin_panel_inquiries_retrieve
summary: Inquiry admin endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryRetrieveAdmin'
description: ''
put:
operationId: api_v1_users_admin_panel_inquiries_update
summary: Inquiry admin endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryUpdateAdmin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/InquiryUpdateAdmin'
multipart/form-data:
schema:
$ref: '#/components/schemas/InquiryUpdateAdmin'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryUpdateResponseAdmin'
description: ''
delete:
operationId: api_v1_users_admin_panel_inquiries_destroy
summary: Inquiry admin endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'204':
description: No response body
/api/v1/users/admin_panel/inquiries/{uuid}/remove-supplier/:
post:
operationId: api_v1_users_admin_panel_inquiries_remove_supplier_create
summary: Inquiry admin endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TargetDeleteAdmin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TargetDeleteAdmin'
multipart/form-data:
schema:
$ref: '#/components/schemas/TargetDeleteAdmin'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TargetDeleteAdmin'
description: ''
/api/v1/users/admin_panel/inquiries/{uuid}/upload/:
post:
operationId: api_v1_users_admin_panel_inquiries_upload_create
summary: Inquiry admin endpoints
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryAdmin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/InquiryAdmin'
multipart/form-data:
schema:
$ref: '#/components/schemas/InquiryAdmin'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InquiryAdmin'
description: ''
/api/v1/users/admin_panel/inquiries/export/:
post:
operationId: api_v1_users_admin_panel_inquiries_export_create
summary: Inquiry admin endpoints
tags:
- Admin panel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportAdmin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExportAdmin'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExportAdmin'
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
description: File
/api/v1/users/admin_panel/messages/:
get:
operationId: api_v1_users_admin_panel_messages_list
summary: Messages admin endpoint
parameters:
- in: query
name: company_uuid
schema:
type: string
format: uuid
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- Admin panel
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAdminMessagesResponseList'
description: ''
/api/v1/users/admin_panel/orders/:
get:
operationId: api_v1_users_admin_panel_orders_list
summary: Order admin endpoint
parameters:
- in: query
name: delivery_status
schema:
type: string
enum:
- delivered
- dispatched
- pending_dispatch
description: '* `pending_dispatch` - pending_dispatch
* `dispatched` - Dispatched
* `delivered` - Delivered'
- in: query
name: include_checkout
schema:
type: boolean
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: payment_status
schema:
type: string
nullable: true
enum:
- paid
- payment_due
- payment_processing
- payment_upcoming
description: 'payment_status [iexact]
* `paid` - paid
* `payment_upcoming` - payment_upcoming
* `payment_processing` - payment_processing
* `payment_due` - payment_due'
- name: search
required: false
in: query
description: A search term.
schema:
type: string
- in: query
name: state
schema:
type: string
enum:
# --- truncated at 32 KB (234 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opply/refs/heads/main/openapi/opply-admin-panel-api-openapi.yml