{
  "opencollection": "1.0.0",
  "info": {
    "name": "Opply Activity Feed Opply Documents API",
    "version": "0.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Opply Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Opply document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/companies/opply-document-types/",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns all available document types for the MoR document upload dropdown."
        },
        {
          "info": {
            "name": "Retrieve Opply document type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/companies/opply-document-types/:uuid/",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns details for a specific document type."
        },
        {
          "info": {
            "name": "List Opply documents (MoR)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents/",
            "params": [
              {
                "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"
            }
          },
          "docs": "Returns all Opply documents for the current MoR company."
        },
        {
          "info": {
            "name": "Create Opply document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Upload a new compliance document (organic certificate, policy, etc.)."
        },
        {
          "info": {
            "name": "List Opply documents (Buyer)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents-buyer/",
            "params": [
              {
                "name": "is_archived",
                "value": "",
                "type": "query",
                "description": "Filter by computed `is_archived` (active vs archived sub-tab)."
              },
              {
                "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."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by computed lifecycle status."
              },
              {
                "name": "type_uuid__in",
                "value": "",
                "type": "query",
                "description": "Filter by comma-separated document type UUIDs."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns Opply compliance documents visible to the buyer. Documents with no countries set are shown to all buyers. Documents with specific countries are only shown to buyers whose company country matches one of those countries."
        },
        {
          "info": {
            "name": "Retrieve Opply document (Buyer)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents-buyer/:uuid/",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns details for a specific Opply document."
        },
        {
          "info": {
            "name": "List document types present on Opply documents visible to the buyer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents-buyer/types-facet/",
            "params": [
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns the distinct `DocumentType`s that have at least one OpplyDocument visible to the current brand (country-scoped). Used by the FE filter dropdown so it only offers types the user can actually narrow to."
        },
        {
          "info": {
            "name": "Retrieve Opply document (MoR)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents/:uuid/",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns details for a specific Opply document."
        },
        {
          "info": {
            "name": "Update Opply document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents/:uuid/",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Update all fields of an existing Opply document."
        },
        {
          "info": {
            "name": "Partial update Opply document",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents/:uuid/",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Update specific fields of an existing Opply document."
        },
        {
          "info": {
            "name": "Delete Opply document",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/companies/opply-documents/:uuid/",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Permanently delete an Opply document."
        }
      ]
    }
  ],
  "bundled": true
}