Ottenere l'elenco dei contraenti

GET/api/crm/v2/contractorsv2

operationId: contractors.default

Autorizzazione

api-token + language + role

Parametri della richiesta

chain_idinteger

Esempio: 1

downloadstring

Valori:yes

Esempio: yes

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

settingsobject

Una delle opzioni

object

contract_accessbooleanobbligatorio

Esempio: true

contractor_idintegerobbligatorio

Esempio: 1

splitted_invoicesbooleanobbligatorio

Esempio: true

minimum_pricenumberobbligatorio

Esempio: 600

sum_invoice_less_minimumbooleanobbligatorio

Esempio: true

rounding_invoicesbooleanobbligatorio

Esempio: false

listarray of object

idintegerobbligatorio

Esempio: 1

entity_name_fullstring

Denominazione completa del contraente

Esempio: Test

ceo_name_firststring

Esempio: John

ceo_name_middlestring

Esempio: Adam

ceo_name_laststring

Esempio: Smith

city_namestringobbligatorio

Esempio: Moscow

branch_namestring

Esempio: Green Basket

readonlybooleanobbligatorio

Esempio: false

paginationobject (Pagination)

max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false

curl -X GET 'https://foodsoul.pro/api/crm/v2/contractors' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: it' \
  -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' => 'it',
        '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": "it",
        "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": "it",
        "role": "partner",
    },
)
data = response.json()

Risposta 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
    }
  }
}

Le richieste vengono inviate a foodsoul.pro, che è l’host di questo portale; non è possibile sceglierne un altro.