Get additional sales source

GET/api/crm/v2/additional_sales.detailsv2

operationId: additionalSales.details

Returns a single additional sales source by link_type and link_id, including a list of related products, product options, and categories in the branch.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

link_typestringrequired

Source type

Values:itemitem_parametercategory

link_idintegerrequired

Source ID

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject (AdditionalSalesItem) required

link_itemobjectrequired

idintegerrequired

Example: 1

typestringrequired

Values:itemitem_parametercategory

Example: item

namestringrequired

Example: Example item

strategystringcan be null

Strategy that created the source; null — created manually

Values:sales_statisticsai_compatibilityai_prompt

Example: sales_statistics

related_objectsarray of objectrequired

idintegerrequired

Example: 1

typestringrequired

Values:itemitem_parametercategory

Example: item

namestringrequired

Example: Recommended item

strategystringcan be null

Strategy that created the link; null — added manually

Values:sales_statisticsai_compatibilityai_prompt

Example: ai_compatibility

sortintegerrequired

Example: 1

idintegerrequired

Example: 1

curl -X GET 'https://foodsoul.pro/api/crm/v2/additional_sales.details?branch_id=1&link_type=item&link_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/additional_sales.details?branch_id=1&link_type=item&link_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/additional_sales.details?branch_id=1&link_type=item&link_id=1", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/additional_sales.details?branch_id=1&link_type=item&link_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {
    "link_item": {
      "id": 1,
      "type": "item",
      "name": "Example item"
    },
    "strategy": "sales_statistics",
    "related_objects": [
      {
        "id": 1,
        "type": "item",
        "name": "Recommended item",
        "strategy": "ai_compatibility"
      }
    ],
    "sort": 1,
    "id": 1
  }
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.