Mendapatkan daftar kode promo

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Otorisasi

api-token + language + role

Parameter permintaan

branch_idinteger

Cabang yang digunakan untuk memfilter daftar. Tanpa parameter ini, hanya filter yang dikembalikan dalam respons, tanpa daftar. Untuk mitra dengan satu cabang, server akan mengisinya secara otomatis.

Contoh: 8778

special_offer_idinteger

Contoh: 1

page_numberinteger

Contoh: 1

Tanggapan

object

statusstringwajib

Nilai:successerror

Contoh: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object

valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

special_offer_idobject (FilterSelect)

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of object

valuestringwajib

Contoh: example

namestringwajib

Contoh: All

modestring (FilterMode)

Nilai:force_shownvalue_required

Contoh: value_required

listarray of object

idintegerwajib

Contoh: 1

codestringwajib

Contoh: CODE1933

countinteger

Contoh: 2

count_activationsintegerwajib

Contoh: 0

date_availablestring (DataTimeFormatSQL)

Contoh: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Contoh: 2024-05-02 08:31:16

bonuses_sumnumber

Contoh: 2.02

bonuses_validityinteger

Contoh: 3

branch_idintegerwajib

Contoh: 8778

special_offer_idinteger

Contoh: 152410

paginationobject (Pagination)

max_countintegerwajib

Jumlah item per halaman

Contoh: 30

page_numberintegerwajib

Nomor halaman saat ini; dibatasi agar offset tidak melebihi 1000

Contoh: 1

has_nextbooleanwajib

Apakah ada halaman berikutnya

Contoh: true

has_previousbooleanwajib

Apakah ada halaman sebelumnya

Contoh: false

timezonestring

Contoh: Europe/Kaliningrad

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/special_offers_promo_codes', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'id', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

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

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "special_offer_id": { "value": "example", "type": "select", "option": [ { "value": "example", "name": "All" } ], "mode": "value_required" } }, "list": [ { "id": 1, "code": "CODE1933", "count": 2, "count_activations": 0, "date_available": "2024-05-02 08:31:16", "date_expiration": "2024-05-02 08:31:16", "bonuses_sum": 2.02, "bonuses_validity": 3, "branch_id": 8778, "special_offer_id": 152410 } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false }, "timezone": "Europe/Kaliningrad" } }