Atualizado em:
25 de Fevereiro de 2026

Prospect

(POST) /sellersprospects

    API Endpoint

        https://api.omnik.io/HUB/v1/sellers
            
                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/sellers' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json'
--data '{
  "tenant": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "userData": {
    "name": "string",
    "login": "string",
    "email": "string"
  },
  "sellerData": {
    "id": "string",
    "companyName": "string",
    "fantasyName": "string",
    "cnae": "string",
    "stateRegistration": "string",
    "municipalRegistration": "string",
    "taxRegime": "string",
    "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
    "website": "string"
  },
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "prospect": true,
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "platforms": [
    {
      "platform": "string",
      "platformId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "financials": [
    {
      "banksData": [
        {
          "marketPlaceId": "string",
          "responsible": "string",
          "bank": "string",
          "BankNumber": "string",
          "branchNumber": "string",
          "branchVerifyingDigit": "string",
          "accountNumber": "string",
          "accountType": "string",
          "accountVerifyingDigit": "string"
        }
      ],
      "documents": [
        {
          "link": "string",
          "code": "string",
          "linkPDF": "string",
          "fileName": "string"
        }
      ]
    }
  ]
}'

                
            
                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "sellerData": {
    "active": true,
    "hubSessionId": "string",
    "id": "string",
    "companyName": "string",
    "fantasyName": "string",
    "cnae": "string",
    "stateRegistration": "string",
    "municipalRegistration": "string",
    "taxRegime": "string",
    "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
    "holding": "string",
    "matrix": "string",
    "branch": "string"
  },
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "situationData": {
    "locked": true,
    "operator": "string",
    "hubSessionId": "string",
    "date": "1970-01-01T00:00:00.000000"
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ],
  "financials": [
    {
      "banksData": [
        {
          "marketPlaceId": "string",
          "responsible": "string",
          "bank": "string",
          "BankNumber": "string",
          "branchNumber": "string",
          "branchVerifyingDigit": "string",
          "accountNumber": "string",
          "accountType": "string",
          "accountVerifyingDigit": "string"
        }
      ],
      "documents": [
        {
          "link": "string",
          "code": "string",
          "linkPDF": "string",
          "fileName": "string"
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "platforms": [
    {
      "platform": "string",
      "platformId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "sellerMarketplaceData": {
    "nameMarketplaceExibition": "string",
    "description": "string",
    "shippingPolicy": "string",
    "returnPolicy": "string",
    "companyLogo": "string",
    "usesMarketplaceShippingPolicy": true,
    "usesMarketplaceReturnPolicy": true,
    "banner": "string",
    "bannerMobile": "string"
  }
}
                
            
                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            
                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Incluir novo Seller Prospect

Header Parameters

Campo Tipo Descrição
token string (required) seu token de acesso
application_id string (required) ID do seu token de acesso

(GET) por ID

    API Endpoint

        https://api.omnik.io/HUB/v1/sellers/{id}
            
                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/sellers/{id}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json'
                
            
                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "sellerData": {
    "active": true,
    "hubSessionId": "string",
    "id": "string",
    "companyName": "string",
    "fantasyName": "string",
    "cnae": "string",
    "stateRegistration": "string",
    "municipalRegistration": "string",
    "taxRegime": "string",
    "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
    "holding": "string",
    "matrix": "string",
    "branch": "string"
  },
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "situationData": {
    "locked": true,
    "operator": "string",
    "hubSessionId": "string",
    "date": "1970-01-01T00:00:00.000000"
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ],
  "financials": [
    {
      "banksData": [
        {
          "marketPlaceId": "string",
          "responsible": "string",
          "bank": "string",
          "BankNumber": "string",
          "branchNumber": "string",
          "branchVerifyingDigit": "string",
          "accountNumber": "string",
          "accountType": "string",
          "accountVerifyingDigit": "string"
        }
      ],
      "documents": [
        {
          "link": "string",
          "code": "string",
          "linkPDF": "string",
          "fileName": "string"
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "platforms": [
    {
      "platform": "string",
      "platformId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "sellerMarketplaceData": {
    "nameMarketplaceExibition": "string",
    "description": "string",
    "shippingPolicy": "string",
    "returnPolicy": "string",
    "companyLogo": "string",
    "usesMarketplaceShippingPolicy": true,
    "usesMarketplaceReturnPolicy": true,
    "banner": "string",
    "bannerMobile": "string"
  }
}
                
            
                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            
                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Consulta de Seller pelo ID

Path Parameters

Campo Tipo Descrição
id string (required) ID do Seller

Header Parameters

Campo Tipo Descrição
token string (required) seu token de acesso
application_id string (required) ID do seu token de acesso

(GET) paginado

    API Endpoint

        https://api.omnik.io/HUB/v1/sellers/
            
                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/sellers/' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json'
                
            
                
Result example 2xx:

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "sort": "string",
  "values": [
    {
      "tenant": "string",
      "operator": "string",
      "createDate": "1970-01-01T00:00:00.000000",
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "sellerData": {
        "active": true,
        "hubSessionId": "string",
        "id": "string",
        "companyName": "string",
        "fantasyName": "string",
        "cnae": "string",
        "stateRegistration": "string",
        "municipalRegistration": "string",
        "taxRegime": "string",
        "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
        "holding": "string",
        "matrix": "string",
        "branch": "string"
      },
      "addressData": {
        "type": "string",
        "zipcode": "string",
        "address": "string",
        "number": "string",
        "complement": "string",
        "neighborhood": "string",
        "city": "string",
        "state": "string",
        "stateAcronym": "string",
        "country": "string"
      },
      "configurationData": {
        "serieNFe": "string",
        "environmentNFe": "string",
        "freighttype": "string",
        "erpIntegrationId": "string",
        "operationalTerm": 0,
        "useShippingOperator": true,
        "useEmissionNFe": true,
        "usePreNFe": true,
        "generateEAN": true,
        "issueNFeWithFreeShipping": true,
        "createIdIntegration": true,
        "hasPhysicalStore": true,
        "quantityPhysicalStores": 0,
        "minimumOrderValue": 0
      },
      "contractData": {
        "status": "string",
        "representative": "string",
        "documents": [
          {
            "link": "string",
            "code": "string",
            "linkPDF": "string",
            "fileName": "string"
          }
        ],
        "dateAccession": "1970-01-01T00:00:00.000000",
        "dataRenewal": "1970-01-01T00:00:00.000000",
        "accessionValue": 0,
        "monthlyPayment": 0,
        "commissionValue": 0,
        "freightCommissionValue": 0,
        "segment": "string",
        "haveDirectContract": true
      },
      "situationData": {
        "locked": true,
        "operator": "string",
        "hubSessionId": "string",
        "date": "1970-01-01T00:00:00.000000"
      },
      "contacts": [
        {
          "type": "string",
          "responsible": "string",
          "email": "string",
          "site": "string",
          "notifyTicket": true,
          "notifyRequestApproved": true,
          "notifyRequestSummary": true,
          "notifyQuestionAbout": true,
          "notifyErrorIntegrationRequest": true,
          "notifyErrorIntegrationProduct": true,
          "notifyTicketIntegration": true,
          "phones": [
            {
              "type": "string",
              "ddi": "string",
              "ddd": "string",
              "number": "string",
              "local": "string"
            }
          ]
        }
      ],
      "financials": [
        {
          "banksData": [
            {
              "marketPlaceId": "string",
              "responsible": "string",
              "bank": "string",
              "BankNumber": "string",
              "branchNumber": "string",
              "branchVerifyingDigit": "string",
              "accountNumber": "string",
              "accountType": "string",
              "accountVerifyingDigit": "string"
            }
          ],
          "documents": [
            {
              "link": "string",
              "code": "string",
              "linkPDF": "string",
              "fileName": "string"
            }
          ]
        }
      ],
      "marketplaces": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "commissionValue": 0,
          "lastUpdate": "1970-01-01T00:00:00.000000",
          "active": true
        }
      ],
      "platforms": [
        {
          "platform": "string",
          "platformId": "string",
          "commissionValue": 0,
          "lastUpdate": "1970-01-01T00:00:00.000000",
          "active": true
        }
      ],
      "sellerMarketplaceData": {
        "nameMarketplaceExibition": "string",
        "description": "string",
        "shippingPolicy": "string",
        "returnPolicy": "string",
        "companyLogo": "string",
        "usesMarketplaceShippingPolicy": true,
        "usesMarketplaceReturnPolicy": true,
        "banner": "string",
        "bannerMobile": "string"
      }
    }
  ]
}
                
            
                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            
                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Consulta de Seller paginada

Header Parameters

Campo Tipo Descrição
token string (required) seu token de acesso
application_id string (required) ID do seu token de acesso

Query Parameters

Campo Tipo Descrição
offset integer (optional) indica a partir de onde ocorre um aumento
limit integer (optional) indica a quantidade de recursos a serem devolvidos, variando de 10 a no máximo 10
sort string (optional) indica por qual atributo a consulta deve ser classificada (lastUpdate ou createDate) (Default lastUpdate)
last_update string($yyyy-MM-dd'T'HH:mm:ss) (optional) last update

(POST) /sellers

    API Endpoint

        https://api.omnik.io/HUB/v1/sellers
            
                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/sellers' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json'
--data '{
  "tenant": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "userData": {
    "name": "string",
    "login": "string",
    "email": "string"
  },
  "sellerData": {
    "id": "string",
    "companyName": "string",
    "fantasyName": "string",
    "cnae": "string",
    "stateRegistration": "string",
    "municipalRegistration": "string",
    "taxRegime": "string",
    "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
    "website": "string"
  },
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "platforms": [
    {
      "platform": "string",
      "platformId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "financials": [
    {
      "banksData": [
        {
          "marketPlaceId": "string",
          "responsible": "string",
          "bank": "string",
          "BankNumber": "string",
          "branchNumber": "string",
          "branchVerifyingDigit": "string",
          "accountNumber": "string",
          "accountType": "string",
          "accountVerifyingDigit": "string"
        }
      ],
      "documents": [
        {
          "link": "string",
          "code": "string",
          "linkPDF": "string",
          "fileName": "string"
        }
      ]
    }
  ],
  "sellerMarketplaceData": {
    "nameMarketplaceExibition": "string",
    "description": "string",
    "shippingPolicy": "string",
    "returnPolicy": "string",
    "companyLogo": "string",
    "usesMarketplaceShippingPolicy": true,
    "usesMarketplaceReturnPolicy": true,
    "banner": "string",
    "bannerMobile": "string"
  }
}'

                
            
                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "sellerData": {
    "active": true,
    "hubSessionId": "string",
    "id": "string",
    "companyName": "string",
    "fantasyName": "string",
    "cnae": "string",
    "stateRegistration": "string",
    "municipalRegistration": "string",
    "taxRegime": "string",
    "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
    "holding": "string",
    "matrix": "string",
    "branch": "string"
  },
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "situationData": {
    "locked": true,
    "operator": "string",
    "hubSessionId": "string",
    "date": "1970-01-01T00:00:00.000000"
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ],
  "financials": [
    {
      "banksData": [
        {
          "marketPlaceId": "string",
          "responsible": "string",
          "bank": "string",
          "BankNumber": "string",
          "branchNumber": "string",
          "branchVerifyingDigit": "string",
          "accountNumber": "string",
          "accountType": "string",
          "accountVerifyingDigit": "string"
        }
      ],
      "documents": [
        {
          "link": "string",
          "code": "string",
          "linkPDF": "string",
          "fileName": "string"
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "platforms": [
    {
      "platform": "string",
      "platformId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "sellerMarketplaceData": {
    "nameMarketplaceExibition": "string",
    "description": "string",
    "shippingPolicy": "string",
    "returnPolicy": "string",
    "companyLogo": "string",
    "usesMarketplaceShippingPolicy": true,
    "usesMarketplaceReturnPolicy": true,
    "banner": "string",
    "bannerMobile": "string"
  }
}
                
            
                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            
                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Incluir novo Seller

Header Parameters

Campo Tipo Descrição
token string (required) seu token de acesso
application_id string (required) ID do seu token de acesso

(PUT) /sellers

    API Endpoint

        https://api.omnik.io/HUB/v1/sellers/{id}
            
                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/sellers/{id}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json'
--data '{
  "tenant": "string",
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ]
}'
                
            
                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "sellerData": {
    "active": true,
    "hubSessionId": "string",
    "id": "string",
    "companyName": "string",
    "fantasyName": "string",
    "cnae": "string",
    "stateRegistration": "string",
    "municipalRegistration": "string",
    "taxRegime": "string",
    "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
    "holding": "string",
    "matrix": "string",
    "branch": "string"
  },
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "situationData": {
    "locked": true,
    "operator": "string",
    "hubSessionId": "string",
    "date": "1970-01-01T00:00:00.000000"
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ],
  "financials": [
    {
      "banksData": [
        {
          "marketPlaceId": "string",
          "responsible": "string",
          "bank": "string",
          "BankNumber": "string",
          "branchNumber": "string",
          "branchVerifyingDigit": "string",
          "accountNumber": "string",
          "accountType": "string",
          "accountVerifyingDigit": "string"
        }
      ],
      "documents": [
        {
          "link": "string",
          "code": "string",
          "linkPDF": "string",
          "fileName": "string"
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "platforms": [
    {
      "platform": "string",
      "platformId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "sellerMarketplaceData": {
    "nameMarketplaceExibition": "string",
    "description": "string",
    "shippingPolicy": "string",
    "returnPolicy": "string",
    "companyLogo": "string",
    "usesMarketplaceShippingPolicy": true,
    "usesMarketplaceReturnPolicy": true,
    "banner": "string",
    "bannerMobile": "string"
  }
}
                
            
                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            
                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Alterar um Seller

Path Parameters

Campo Tipo Descrição
id string (required) ID do Seller

Header Parameters

Campo Tipo Descrição
token string (required) seu token de acesso
application_id string (required) ID do seu token de acesso

(PUT) /commission

    API Endpoint

        https://api.omnik.io/HUB/v1/sellers/{id}/commission
            
                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/sellers/{id}/commission' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json' \
--data '{
  "commissionValue": "number",
  "freightCommissionValue": "number"
}'
                
            
                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "sellerData": {
    "active": true,
    "hubSessionId": "string",
    "id": "string",
    "companyName": "string",
    "fantasyName": "string",
    "cnae": "string",
    "stateRegistration": "string",
    "municipalRegistration": "string",
    "taxRegime": "string",
    "dateAccessionNationalSimple": "1970-01-01T00:00:00.000000",
    "holding": "string",
    "matrix": "string",
    "branch": "string"
  },
  "addressData": {
    "type": "string",
    "zipcode": "string",
    "address": "string",
    "number": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "stateAcronym": "string",
    "country": "string"
  },
  "configurationData": {
    "serieNFe": "string",
    "environmentNFe": "string",
    "freighttype": "string",
    "erpIntegrationId": "string",
    "operationalTerm": 0,
    "useShippingOperator": true,
    "useEmissionNFe": true,
    "usePreNFe": true,
    "generateEAN": true,
    "issueNFeWithFreeShipping": true,
    "createIdIntegration": true,
    "hasPhysicalStore": true,
    "quantityPhysicalStores": 0,
    "minimumOrderValue": 0
  },
  "contractData": {
    "status": "string",
    "representative": "string",
    "documents": [
      {
        "link": "string",
        "code": "string",
        "linkPDF": "string",
        "fileName": "string"
      }
    ],
    "dateAccession": "1970-01-01T00:00:00.000000",
    "dataRenewal": "1970-01-01T00:00:00.000000",
    "accessionValue": 0,
    "monthlyPayment": 0,
    "commissionValue": 0,
    "freightCommissionValue": 0,
    "segment": "string",
    "haveDirectContract": true
  },
  "situationData": {
    "locked": true,
    "operator": "string",
    "hubSessionId": "string",
    "date": "1970-01-01T00:00:00.000000"
  },
  "contacts": [
    {
      "type": "string",
      "responsible": "string",
      "email": "string",
      "site": "string",
      "notifyTicket": true,
      "notifyRequestApproved": true,
      "notifyRequestSummary": true,
      "notifyQuestionAbout": true,
      "notifyErrorIntegrationRequest": true,
      "notifyErrorIntegrationProduct": true,
      "notifyTicketIntegration": true,
      "phones": [
        {
          "type": "string",
          "ddi": "string",
          "ddd": "string",
          "number": "string",
          "local": "string"
        }
      ]
    }
  ],
  "financials": [
    {
      "banksData": [
        {
          "marketPlaceId": "string",
          "responsible": "string",
          "bank": "string",
          "BankNumber": "string",
          "branchNumber": "string",
          "branchVerifyingDigit": "string",
          "accountNumber": "string",
          "accountType": "string",
          "accountVerifyingDigit": "string"
        }
      ],
      "documents": [
        {
          "link": "string",
          "code": "string",
          "linkPDF": "string",
          "fileName": "string"
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "platforms": [
    {
      "platform": "string",
      "platformId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ],
  "sellerMarketplaceData": {
    "nameMarketplaceExibition": "string",
    "description": "string",
    "shippingPolicy": "string",
    "returnPolicy": "string",
    "companyLogo": "string",
    "usesMarketplaceShippingPolicy": true,
    "usesMarketplaceReturnPolicy": true,
    "banner": "string",
    "bannerMobile": "string"
  }
}
                
            
                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            
                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Alterar Comissionamento do Seller

Path Parameters

Campo Tipo Descrição
id string (required) ID do Seller

Header Parameters

Campo Tipo Descrição
token string (required) seu token de acesso
application_id string (required) ID do seu token de acesso

Body Parameters

Campo Tipo Descrição
commissionValue number (optional) valor da comissão (maior que 0 e menor que 100)
freightCommissionValue number (optional) valor da comissão de Frete (maior que 0 e menor que 100)