Obter a lista de contratantes

GET/api/crm/v2/contractorsv2

operationId: contractors.default

Autorização

api-token + language + role

Parâmetros de consulta

chain_idinteger

Exemplo: 1

downloadstring

Valores:yes

Exemplo: yes

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

settingsobject

Uma das opções

object

contract_accessbooleanobrigatório

Exemplo: true

contractor_idintegerobrigatório

Exemplo: 1

splitted_invoicesbooleanobrigatório

Exemplo: true

minimum_pricenumberobrigatório

Exemplo: 600

sum_invoice_less_minimumbooleanobrigatório

Exemplo: true

rounding_invoicesbooleanobrigatório

Exemplo: false

listarray of object

idintegerobrigatório

Exemplo: 1

entity_name_fullstring

Nome completo do contratante

Exemplo: Test

ceo_name_firststring

Exemplo: John

ceo_name_middlestring

Exemplo: Adam

ceo_name_laststring

Exemplo: Smith

city_namestringobrigatório

Exemplo: Moscow

branch_namestring

Exemplo: Green Basket

readonlybooleanobrigatório

Exemplo: false

paginationobject (Pagination)

max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false

curl -X GET 'https://foodsoul.pro/api/crm/v2/contractors' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/contractors', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/contractors", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/contractors",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
)
data = response.json()

Resposta 200

{
  "status": "success",
  "data": {
    "filters": {},
    "settings": {
      "contract_access": true,
      "contractor_id": 1,
      "splitted_invoices": true,
      "minimum_price": 600,
      "sum_invoice_less_minimum": true,
      "rounding_invoices": false
    },
    "list": [
      {
        "id": 1,
        "entity_name_full": "Test",
        "ceo_name_first": "John",
        "ceo_name_middle": "Adam",
        "ceo_name_last": "Smith",
        "city_name": "Moscow",
        "branch_name": "Green Basket",
        "readonly": false
      }
    ],
    "pagination": {
      "max_count": 30,
      "page_number": 1,
      "has_next": true,
      "has_previous": false
    }
  }
}

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.