Obtener la lista de contratistas

GET/api/crm/v2/contractorsv2

operationId: contractors.default

Autorización

api-token + language + role

Parámetros de consulta

chain_idinteger

Ejemplo: 1

downloadstring

Valores:yes

Ejemplo: yes

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

settingsobject

Una de las opciones

object

contract_accessbooleanobligatorio

Ejemplo: true

contractor_idintegerobligatorio

Ejemplo: 1

splitted_invoicesbooleanobligatorio

Ejemplo: true

minimum_pricenumberobligatorio

Ejemplo: 600

sum_invoice_less_minimumbooleanobligatorio

Ejemplo: true

rounding_invoicesbooleanobligatorio

Ejemplo: false

listarray of object

idintegerobligatorio

Ejemplo: 1

entity_name_fullstring

Nombre completo del contratista

Ejemplo: Test

ceo_name_firststring

Ejemplo: John

ceo_name_middlestring

Ejemplo: Adam

ceo_name_laststring

Ejemplo: Smith

city_namestringobligatorio

Ejemplo: Moscow

branch_namestring

Ejemplo: Green Basket

readonlybooleanobligatorio

Ejemplo: false

paginationobject (Pagination)

max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false

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

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

Las solicitudes se envían a foodsoul.pro, que es el host de este portal; no se puede elegir otro.