Kļūdu kodi
Ja pieprasījums neizdodas, pārbaudiet atbildē norādīto kļūdas kodu. Atveriet to zemāk esošajā sarakstā, lai uzzinātu, kas notika un ko darīt tālāk. Pie katras kļūdas ir arī atbildes piemērs un norādes par pieprasījuma atkārtošanu.
400request.malformedPieprasījumu nevar parsēt.
- Ko darīt
- Pārbaudiet JSON sintaksi, URL kodējumu un pieprasījuma struktūru.
- Atkārtošanas noteikumi
- Atkārtojiet pēc pieprasījuma labošanas.
{
"error": {
"code": "request.malformed",
"fields": null,
"message": "The request could not be read."
},
"meta": {
"request_id": "example-request"
}
}
401authentication.invalid_credentialsAPI atslēga vai piekļuves marķieris ir nederīgs, beidzies vai atsaukts.
- Ko darīt
- Pārbaudiet veikala URL un piekļuves datus. Iegūstiet jaunu marķieri ar aktīvu API atslēgu.
- Atkārtošanas noteikumi
- Atkārtojiet pēc autentifikācijas labošanas; neveiciet atkārtotus pieprasījumus ar nederīgu marķieri.
{
"error": {
"code": "authentication.invalid_credentials",
"fields": null,
"message": "The credentials are invalid."
},
"meta": {
"request_id": "example-request"
}
}
401authentication.requiredTrūkst nepieciešamās Authorization galvenes vai tās shēma ir nepareiza.
- Ko darīt
- Lai izsniegtu vai atsauktu tokenu, izmantojiet API atslēgu ar
ApiKeygalvenēAuthorization. Citiem pieprasījumiem izmantojiet piekļuves tokenu arBearer. - Atkārtošanas noteikumi
- Atkārtojiet pēc pareizās galvenes pievienošanas.
{
"error": {
"code": "authentication.required",
"fields": null,
"message": "Authentication is required."
},
"meta": {
"request_id": "example-request"
}
}
403authorization.client_ip_unverifiedPakalpojums nevarēja noteikt uzticamu klienta IP adresi.
- Ko darīt
- Pārbaudiet, no kuras IP adreses integrācija savienojas ar API. Ja kļūda saglabājas, sazinieties ar Shopently tehnisko atbalstu.
- Atkārtošanas noteikumi
- Mēģiniet vēlreiz, kad IP adreses noteikšanas problēma ir atrisināta.
{
"error": {
"code": "authorization.client_ip_unverified",
"fields": null,
"message": "The client IP address could not be verified."
},
"meta": {
"request_id": "example-request"
}
}
403authorization.ip_not_allowedAvota IP adrese nav atslēgas atļauto adrešu sarakstā.
- Ko darīt
- Izmantojiet atļautu avota adresi vai lūdziet pilnvarotam administratoram rediģēt atslēgas IP sarakstu.
- Atkārtošanas noteikumi
- Atkārtojiet tikai pēc adreses atļaušanas.
{
"error": {
"code": "authorization.ip_not_allowed",
"fields": null,
"message": "Access from this IP address is not allowed."
},
"meta": {
"request_id": "example-request"
}
}
403authorization.scope_deniedAtslēgai nav šai darbībai nepieciešamas spēkā esošas atļaujas.
- Ko darīt
- Pārbaudiet darbības obligātās un nosacītās atļaujas, atslēgas grantus un izdevēja piekļuvi.
- Atkārtošanas noteikumi
- Atkārtojiet pēc tam, kad pilnvarots administrators piešķir nepieciešamo piekļuvi.
{
"error": {
"code": "authorization.scope_denied",
"fields": null,
"message": "The required permission has not been granted."
},
"meta": {
"request_id": "example-request"
}
}
403entitlements.api_disabledŠim veikalam API piekļuve ir atspējota.
- Ko darīt
- Lūdziet veikala īpašniekam pārbaudīt aktīvo plānu un API pieejamību.
- Atkārtošanas noteikumi
- Neatkārtojiet, līdz API piekļuve ir ieslēgta.
{
"error": {
"code": "entitlements.api_disabled",
"fields": null,
"message": "API access is disabled for this store."
},
"meta": {
"request_id": "example-request"
}
}
403entitlements.limit_exceededIzmaiņa pārsniegtu pašreizējā plāna limitu.
- Ko darīt
- Pārbaudiet attiecīgo resursa limitu un pielāgojiet iecerēto izmaiņu vai plānu.
- Atkārtošanas noteikumi
- Atkārtojiet pēc limita atrisināšanas; ja pieprasījums mainās, izmantojiet jaunu idempotences atslēgu.
{
"error": {
"code": "entitlements.limit_exceeded",
"fields": null,
"message": "The operation exceeds a plan limit."
},
"meta": {
"request_id": "example-request"
}
}
403entitlements.operation_disabledPašreizējais plāns neietver šo darbību.
- Ko darīt
- Pārbaudiet darbībai norādīto minimālo plānu.
- Atkārtošanas noteikumi
- Atkārtojiet, kad plāns atļauj darbību un atslēgai ir nepieciešamās atļaujas.
{
"error": {
"code": "entitlements.operation_disabled",
"fields": null,
"message": "The current plan does not allow this operation."
},
"meta": {
"request_id": "example-request"
}
}
403entitlements.resource_blockedPlāna limits bloķē šo konkrēto resursu.
- Ko darīt
- Lūdziet īpašniekam novērst resursa plāna ierobežojumu.
- Atkārtošanas noteikumi
- Neatkārtojiet to pašu pieprasījumu, kamēr resurss ir bloķēts.
{
"error": {
"code": "entitlements.resource_blocked",
"fields": null,
"message": "A plan limit blocks access to this resource."
},
"meta": {
"request_id": "example-request"
}
}
404resource.not_foundResurss neeksistē, ir dzēsts vai nav pieejams ar norādīto identifikatoru.
- Ko darīt
- Pārbaudiet veikalu, resursa ceļu un identifikatoru. Izmantojiet šī veikala atgrieztos identifikatorus.
- Atkārtošanas noteikumi
- Atkārtojiet tikai pēc mērķa labošanas vai tā esamības apstiprināšanas.
{
"error": {
"code": "resource.not_found",
"fields": null,
"message": "The resource was not found."
},
"meta": {
"request_id": "example-request"
}
}
405request.method_not_allowedGalapunkts neatbalsta šo HTTP metodi.
- Ko darīt
- Izmantojiet dokumentēto metodi; Allow galvene norāda atbalstītās metodes.
- Atkārtošanas noteikumi
- Neatkārtojiet neatbalstīto metodi.
{
"error": {
"code": "request.method_not_allowed",
"fields": null,
"message": "This method is not supported for this resource."
},
"meta": {
"request_id": "example-request"
}
}
409idempotency.key_reusedŠī idempotences atslēga pieder citam pieprasījumam.
- Ko darīt
- Atrodiet sākotnējo darbību. Jaunu atslēgu izmantojiet tikai apzināti jaunai loģiskai darbībai.
- Atkārtošanas noteikumi
- Neatkārtojiet mainītu saturu ar konfliktējošo atslēgu.
{
"error": {
"code": "idempotency.key_reused",
"fields": null,
"message": "This idempotency key was used with a different request."
},
"meta": {
"request_id": "example-request"
}
}
409resource.already_existsUnikāla vērtība konfliktē ar esošu resursu.
- Ko darīt
- Nolasiet esošo resursu un izlemiet, vai to izmantot vai izvēlēties citu unikālu vērtību.
- Atkārtošanas noteikumi
- Neatkārtojiet to pašu konfliktējošo izveidi.
{
"error": {
"code": "resource.already_exists",
"fields": null,
"message": "A resource with these unique values already exists."
},
"meta": {
"request_id": "example-request"
}
}
409resource.in_useCiti resursi joprojām ir atkarīgi no šī resursa.
- Ko darīt
- Pārskatiet atkarības un pirms dzēšanas noņemiet vai mainiet tās ar atbalstītām darbībām.
- Atkārtošanas noteikumi
- Atkārtojiet pēc atkarību atrisināšanas.
{
"error": {
"code": "resource.in_use",
"fields": null,
"message": "The resource is still in use."
},
"meta": {
"request_id": "example-request"
}
}
409resource.state_conflictPašreizējais biznesa stāvoklis neļauj šo izmaiņu.
- Ko darīt
- Nolasiet pašreizējo stāvokli un izvēlieties derīgu biznesa pāreju.
- Atkārtošanas noteikumi
- Nespiediet automātiski un neatkārtojiet konfliktējošo izmaiņu.
{
"error": {
"code": "resource.state_conflict",
"fields": null,
"message": "The current resource state does not allow this operation."
},
"meta": {
"request_id": "example-request"
}
}
409resource.version_conflictCita rakstīšana mainīja resursu pēc jūsu nolasītās versijas.
- Ko darīt
- Nolasiet jaunāko stāvokli, saskaņojiet izmaiņu un iesniedziet jaunu expected_version.
- Atkārtošanas noteikumi
- Pārskatītajai darbībai izmantojiet jaunu idempotences atslēgu; nepārrakstiet akli.
{
"error": {
"code": "resource.version_conflict",
"fields": null,
"message": "The resource version has changed."
},
"meta": {
"request_id": "example-request"
}
}
409storage.limit_reachedSasniegts attēlu un failu glabāšanas limits. Atbrīvojiet vietu vai palieliniet limitu.
- Ko darīt
- Sasniegts attēlu un failu glabāšanas limits. Atbrīvojiet vietu vai palieliniet limitu.
- Atkārtošanas noteikumi
- Atkārtojiet mazākas derīgas darbības ar katras savu idempotences atslēgu.
{
"error": {
"code": "storage.limit_reached",
"fields": null,
"message": "The upload storage limit is reached."
},
"meta": {
"request_id": "example-request"
}
}
413request.too_largePieprasījums pārsniedz izmēra limitu.
- Ko darīt
- Samaziniet saturu vai sadaliet darbu atbalstītās atsevišķās darbībās.
- Atkārtošanas noteikumi
- Atkārtojiet mazākas derīgas darbības ar katras savu idempotences atslēgu.
{
"error": {
"code": "request.too_large",
"fields": null,
"message": "The request exceeds the size limit."
},
"meta": {
"request_id": "example-request"
}
}
415request.unsupported_media_typeMultivides tips vai satura kodējums nav atbalstīts.
- Ko darīt
- JSON rakstīšanai izmantojiet Content-Type: application/json un atbalstītu nesaspiestu saturu.
- Atkārtošanas noteikumi
- Atkārtojiet pēc multivides tipa vai kodējuma labošanas.
{
"error": {
"code": "request.unsupported_media_type",
"fields": null,
"message": "The request media type or encoding is not supported."
},
"meta": {
"request_id": "example-request"
}
}
416request.range_not_satisfiableIerobežojumi: Range
- Ko darīt
- Range: bytes=0-(size_bytes-1)
- Atkārtošanas noteikumi
- Atkārtojiet pēc pieprasījuma labošanas.
{
"error": {
"code": "request.range_not_satisfiable",
"fields": null,
"message": "The requested byte range is unavailable."
},
"meta": {
"request_id": "example-request"
}
}
422request.validation_failedViens vai vairāki lauki vai parametri neiztur validāciju.
- Ko darīt
- Apskatiet error.fields, pēc tam pārbaudiet obligātos laukus, null atļaušanu, identifikatorus un atļautās vērtības.
- Atkārtošanas noteikumi
- Atkārtojiet labotu pieprasījumu; mainīta rakstīšana ir jauna loģiska darbība.
{
"error": {
"code": "request.validation_failed",
"fields": null,
"message": "Some request parameters are invalid."
},
"meta": {
"request_id": "example-request"
}
}
429capacity.queue_fullĪsā API rinda ir pilna; pieprasījuma izpilde nav sākusies.
- Ko darīt
- Ievietojiet pieprasījumus rindā un ievērojiet atbildes Retry-After galveni.
- Atkārtošanas noteikumi
- Nogaidiet vismaz
Retry-Afternorādīto sekunžu skaitu. Ja atkārtojat ierakstīšanu, saglabājiet to pašu pieprasījuma saturu unIdempotency-Keyvērtību.
{
"error": {
"code": "capacity.queue_full",
"fields": null,
"message": "The API is busy. Please retry shortly."
},
"meta": {
"request_id": "example-request"
}
}
429capacity.wait_timeoutBeidzies gaidīšanas laiks API rindā; pieprasījuma izpilde nav sākusies.
- Ko darīt
- Ievietojiet pieprasījumus rindā un ievērojiet atbildes Retry-After galveni.
- Atkārtošanas noteikumi
- Nogaidiet vismaz
Retry-Afternorādīto sekunžu skaitu. Ja atkārtojat ierakstīšanu, saglabājiet to pašu pieprasījuma saturu unIdempotency-Keyvērtību.
{
"error": {
"code": "capacity.wait_timeout",
"fields": null,
"message": "The API could not start this request in time. Please retry shortly."
},
"meta": {
"request_id": "example-request"
}
}
429rate_limit.exceededPieprasījumu biežums pārsniedz piemērojamo limitu.
- Ko darīt
- Ievietojiet pieprasījumus rindā un ievērojiet atbildes Retry-After galveni.
- Atkārtošanas noteikumi
- Nogaidiet vismaz
Retry-Afternorādīto sekunžu skaitu. Ja atkārtojat ierakstīšanu, saglabājiet to pašu pieprasījuma saturu unIdempotency-Keyvērtību.
{
"error": {
"code": "rate_limit.exceeded",
"fields": null,
"message": "The request rate limit has been exceeded."
},
"meta": {
"request_id": "example-request"
}
}
500internal.errorRadās neparedzēta pakalpojuma kļūda.
- Ko darīt
- Pirms pieprasījuma atkārtošanas nedaudz nogaidiet. Ja kļūda 500 atkārtojas, sazinieties ar Shopently tehnisko atbalstu un norādiet pieprasījuma identifikatoru.
- Atkārtošanas noteikumi
- Pēc īsas pauzes varat vēlreiz mēģināt lasīt datus. Atkārtojot ierakstīšanu, izmantojiet to pašu
Idempotency-Keyvērtību un nemainiet pieprasījuma saturu.
{
"error": {
"code": "internal.error",
"fields": null,
"message": "An unexpected error occurred."
},
"meta": {
"request_id": "example-request"
}
}
502gateway.bad_responseVārteja nesaņēma derīgu API atbildi.
- Ko darīt
- Saglabājiet pieprasījuma identifikatoru. Neveiksmīga atbilde nepierāda, ka rakstīšana nav veikta.
- Atkārtošanas noteikumi
- Izmantojiet ierobežotus atkārtojumus ar pieaugošu aizkavi; to pašu loģisko rakstīšanu atkārtojiet ar sākotnējo Idempotency-Key un saturu.
{
"error": {
"code": "gateway.bad_response",
"fields": null,
"message": "The API gateway could not obtain a valid response."
},
"meta": {
"request_id": "example-request"
}
}
504gateway.timeoutVārtejai beidzās API atbildes gaidīšanas laiks.
- Ko darīt
- Ja pieprasījums mainīja datus, pārbaudiet, vai izmaiņas ir saglabātas veikalā. Atbildes trūkums nenozīmē, ka ierakstīšana neizdevās. Ja kļūda saglabājas, sazinieties ar Shopently tehnisko atbalstu un norādiet pieprasījuma identifikatoru.
- Atkārtošanas noteikumi
- Pēc īsas pauzes varat vēlreiz mēģināt lasīt datus. Atkārtojot ierakstīšanu, izmantojiet to pašu
Idempotency-Keyvērtību un nemainiet pieprasījuma saturu.
{
"error": {
"code": "gateway.timeout",
"fields": null,
"message": "The API gateway timed out."
},
"meta": {
"request_id": "example-request"
}
}