Ana içeriğe geç

update-team-modules

POST /api/partner/update-team-modules/{slug}

Çalışma alanında yalnızca gönderilen modüller açık kalır; gönderilmeyenler kapanır. custom_domain ve shopify_pos bu uçla değişmez: çalışma alanında açıksa açık kalırlar. Sandbox'ta bütün modüller her zaman açıktır ve bu uç 403 döner.

Kimlik doğrulama​

İş ortağı anahtarıyla: X-Api-Key, X-Timestamp, X-Signature, Content-Type: application/json. Ayrıntılar: İş ortağı anahtarı.

İstek​

{
"slug": "4829103756",
"modules": ["api", "orders", "subscription", "saved_cards"]
}
AlanTipZorunluAçıklama
slugstringevetÇalışma alanının slug'ı. Adresteki slug'la aynı olmalıdır.
modulesarrayevetAçık kalacak modüller: api, orders, subscription, payment_links, saved_cards, bank_transactions. Her biri bir kez. Bütün modülleri kapatmak için [].

Bir modül, ona bağlı bir şey sürerken kapatılamaz; istek 422 döner ve hiçbir modül değişmez.

SDK örnekleri​

not

Örneklerdeki $partner / partner nesnesi iş ortağı anahtarıyla kurulan PartnerClient'tır; kurulumu: İş ortağı anahtarı.

use Gurmehub\Odemehub\Request\UpdateTeamModules;

$team = $partner->updateTeamModules(new UpdateTeamModules(
slug: $teamSlug,
modules: ['api', 'orders'], // gönderilmeyenler kapanır; [] hepsini kapatır
))->team;

$team->modules;

Yanıt​

result ve çalışma alanının güncel hâli (team): Çalışma alanı nesnesi.

HTTP durum kodları​

KodDurum
200Modüller güncellendi.
401İş ortağı anahtarı ya da imza geçersiz.
403Sandbox: Sandbox'ta bütün modüller açıktır; modüller değiştirilemez.
404Bu çalışma alanı bulunamadı. Çalışma alanı yok ya da sizin açtığınız bir çalışma alanı değil.
422Doğrulama hatası ya da kapatılamayan modül.
429Dakikada 60 istek sınırı aşıldı.

Hatalar​

AlanMesaj
slugGövdedeki slug adresteki slug ile aynı olmalı.
modules.*Bu modülü iş ortağı açamaz. (custom_domain, shopify_pos ya da tanınmayan bir değer)
modulesSürmekte olan {n} abonelik var; Abonelikler kapatılamaz.
modulesAbonelikler yenilemeleri kayıtlı karttan çeker; Abonelikler açıkken Kayıtlı Kartlar kapatılamaz.