Mine sisu juurde
ShopentlyLearn

Veakoodid

Kui päring ebaõnnestub, vaata vastuses olevat veakoodi. Ava see allolevas loendis, et teada saada, mis juhtus ja mida edasi teha. Iga vea juures on ka vastuse näide ja juhised päringu kordamiseks.

400request.malformedPäringut ei saa parsida.
Mida teha
Kontrolli JSON-i süntaksit, URL-kodeeringut ja päringu struktuuri.
Korduskatsete reeglid
Proovi pärast päringu parandamist uuesti.
Vastus
{
  "error": {
    "code": "request.malformed",
    "fields": null,
    "message": "The request could not be read."
  },
  "meta": {
    "request_id": "example-request"
  }
}

401authentication.invalid_credentialsAPI-võti või pääsutoken on vigane, aegunud või tühistatud.
Mida teha
Kontrolli poe URL-i ja pääsuandmeid. Hangi aktiivse API-võtmega uus token.
Korduskatsete reeglid
Proovi pärast autentimise parandamist uuesti; väldi korduvaid päringuid vigase tokeniga.
Vastus
{
  "error": {
    "code": "authentication.invalid_credentials",
    "fields": null,
    "message": "The credentials are invalid."
  },
  "meta": {
    "request_id": "example-request"
  }
}

401authentication.requiredNõutav Authorization-päis puudub või selle skeem on vale.
Mida teha
Tokeni väljastamiseks või tühistamiseks kasuta API võtit koos ApiKey tähisega päises Authorization. Teiste päringute jaoks kasuta juurdepääsutokenit koos Bearer tähisega.
Korduskatsete reeglid
Proovi pärast õige päise lisamist uuesti.
Vastus
{
  "error": {
    "code": "authentication.required",
    "fields": null,
    "message": "Authentication is required."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403authorization.client_ip_unverifiedTeenus ei suutnud määrata usaldusväärset kliendi IP-aadressi.
Mida teha
Kontrolli, milliselt IP-aadressilt integratsioon API-ga ühendub. Kui viga püsib, võta ühendust Shopently tehnilise toega.
Korduskatsete reeglid
Proovi uuesti, kui IP-aadressi tuvastamise probleem on lahendatud.
Vastus
{
  "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_allowedLähte-IP-aadress ei kuulu võtme lubatud aadresside nimekirja.
Mida teha
Kasuta heakskiidetud lähteaadressi või palu volitatud administraatoril muuta võtme IP-nimekirja.
Korduskatsete reeglid
Proovi uuesti alles pärast aadressi lubamist.
Vastus
{
  "error": {
    "code": "authorization.ip_not_allowed",
    "fields": null,
    "message": "Access from this IP address is not allowed."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403authorization.scope_deniedVõtmel puudub selle toimingu nõutav kehtiv õigus.
Mida teha
Kontrolli toimingu nõutavaid ja tingimuslikke õigusi, võtmele antud õigusi ning võtme väljastaja juurdepääsu.
Korduskatsete reeglid
Proovi pärast seda, kui volitatud administraator annab vajaliku juurdepääsu.
Vastus
{
  "error": {
    "code": "authorization.scope_denied",
    "fields": null,
    "message": "The required permission has not been granted."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.api_disabledSelle poe API-juurdepääs on keelatud.
Mida teha
Palu poe omanikul kontrollida aktiivset paketti ja API saadavust.
Korduskatsete reeglid
Ära korda päringut enne API-juurdepääsu lubamist.
Vastus
{
  "error": {
    "code": "entitlements.api_disabled",
    "fields": null,
    "message": "API access is disabled for this store."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.limit_exceededMuudatus ületaks praeguse paketi piirangu.
Mida teha
Kontrolli kehtivat ressursipiirangut ning kohanda kavandatud muudatust või paketti.
Korduskatsete reeglid
Proovi pärast piirangu lahendamist uuesti; päringu muutumisel kasuta uut idempotentsusvõtit.
Vastus
{
  "error": {
    "code": "entitlements.limit_exceeded",
    "fields": null,
    "message": "The operation exceeds a plan limit."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.operation_disabledPraegune pakett ei sisalda seda toimingut.
Mida teha
Kontrolli toimingu juures näidatud minimaalset paketti.
Korduskatsete reeglid
Proovi uuesti, kui pakett lubab toimingut ja võtmel on nõutavad õigused.
Vastus
{
  "error": {
    "code": "entitlements.operation_disabled",
    "fields": null,
    "message": "The current plan does not allow this operation."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.resource_blockedPaketi piirang blokeerib selle ressursi.
Mida teha
Palu omanikul lahendada ressursile kehtiv paketipiirang.
Korduskatsete reeglid
Ära korda sama päringut, kuni ressurss on blokeeritud.
Vastus
{
  "error": {
    "code": "entitlements.resource_blocked",
    "fields": null,
    "message": "A plan limit blocks access to this resource."
  },
  "meta": {
    "request_id": "example-request"
  }
}

404resource.not_foundRessurss puudub, on kustutatud või pole antud identifikaatoriga kättesaadav.
Mida teha
Kontrolli poodi, ressursi teed ja identifikaatorit. Kasuta selle poe tagastatud identifikaatoreid.
Korduskatsete reeglid
Proovi uuesti ainult pärast sihi parandamist või selle olemasolu kinnitamist.
Vastus
{
  "error": {
    "code": "resource.not_found",
    "fields": null,
    "message": "The resource was not found."
  },
  "meta": {
    "request_id": "example-request"
  }
}

405request.method_not_allowedLõpp-punkt ei toeta seda HTTP-meetodit.
Mida teha
Kasuta dokumenteeritud meetodit; Allow-päis näitab toetatud meetodeid.
Korduskatsete reeglid
Ära korda toetamata meetodit.
Vastus
{
  "error": {
    "code": "request.method_not_allowed",
    "fields": null,
    "message": "This method is not supported for this resource."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409idempotency.key_reusedSee idempotentsusvõti kuulub teisele päringule.
Mida teha
Leia algne toiming. Kasuta uut võtit ainult teadlikult uue loogilise toimingu jaoks.
Korduskatsete reeglid
Ära korda muudetud sisu vastuolus oleva võtmega.
Vastus
{
  "error": {
    "code": "idempotency.key_reused",
    "fields": null,
    "message": "This idempotency key was used with a different request."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.already_existsKordumatu väärtus on vastuolus olemasoleva ressursiga.
Mida teha
Loe olemasolev ressurss ja otsusta, kas seda kasutada või valida teine kordumatu väärtus.
Korduskatsete reeglid
Ära korda sama vastuolulist loomist.
Vastus
{
  "error": {
    "code": "resource.already_exists",
    "fields": null,
    "message": "A resource with these unique values already exists."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.in_useTeised ressursid sõltuvad endiselt sellest ressursist.
Mida teha
Kontrolli sõltuvusi ning eemalda või muuda need toetatud toimingutega enne kustutamist.
Korduskatsete reeglid
Proovi pärast sõltuvuste lahendamist uuesti.
Vastus
{
  "error": {
    "code": "resource.in_use",
    "fields": null,
    "message": "The resource is still in use."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.state_conflictPraegune äriline seisund takistab seda muudatust.
Mida teha
Loe praegune seisund ja vali kehtiv äriline üleminek.
Korduskatsete reeglid
Ära sunni vastuolulist muudatust automaatselt peale ega saada seda korduvalt.
Vastus
{
  "error": {
    "code": "resource.state_conflict",
    "fields": null,
    "message": "The current resource state does not allow this operation."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.version_conflictTeine muudatus muutis ressurssi pärast sinu loetud versiooni.
Mida teha
Loe uusim seisund, kooskõlasta oma muudatus ja saada uus expected_version.
Korduskatsete reeglid
Kasuta parandatud toimingu jaoks uut idempotentsusvõtit; ära kirjuta andmeid pimesi üle.
Vastus
{
  "error": {
    "code": "resource.version_conflict",
    "fields": null,
    "message": "The resource version has changed."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409storage.limit_reachedPiltide ja failide salvestusmahu piir on täis. Vabasta ruumi või suurenda piiri.
Mida teha
Piltide ja failide salvestusmahu piir on täis. Vabasta ruumi või suurenda piiri.
Korduskatsete reeglid
Proovi väiksemaid kehtivaid toiminguid nende oma idempotentsusvõtmetega.
Vastus
{
  "error": {
    "code": "storage.limit_reached",
    "fields": null,
    "message": "The upload storage limit is reached."
  },
  "meta": {
    "request_id": "example-request"
  }
}

413request.too_largePäring ületab suuruspiirangut.
Mida teha
Vähenda sisu või jaga töö toetatud üksiktoiminguteks.
Korduskatsete reeglid
Proovi väiksemaid kehtivaid toiminguid nende oma idempotentsusvõtmetega.
Vastus
{
  "error": {
    "code": "request.too_large",
    "fields": null,
    "message": "The request exceeds the size limit."
  },
  "meta": {
    "request_id": "example-request"
  }
}

415request.unsupported_media_typeMeediatüüp või sisukodeering pole toetatud.
Mida teha
JSON-muudatuste jaoks kasuta Content-Type: application/json ning toetatud tihendamata sisu.
Korduskatsete reeglid
Proovi pärast meediatüübi või kodeeringu parandamist uuesti.
Vastus
{
  "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_satisfiablePiirangud: Range
Mida teha
Range: bytes=0-(size_bytes-1)
Korduskatsete reeglid
Proovi pärast päringu parandamist uuesti.
Vastus
{
  "error": {
    "code": "request.range_not_satisfiable",
    "fields": null,
    "message": "The requested byte range is unavailable."
  },
  "meta": {
    "request_id": "example-request"
  }
}

422request.validation_failedÜks või mitu välja või parameetrit ei läbi valideerimist.
Mida teha
Vaata error.fields ning kontrolli kohustuslikke välju, null-i lubamist, identifikaatoreid ja lubatud väärtusi.
Korduskatsete reeglid
Saada parandatud päring; muudetud kirjutuspäring on uus loogiline toiming.
Vastus
{
  "error": {
    "code": "request.validation_failed",
    "fields": null,
    "message": "Some request parameters are invalid."
  },
  "meta": {
    "request_id": "example-request"
  }
}

429capacity.queue_fullLühike API järjekord on täis; päringu täitmine ei ole alanud.
Mida teha
Pane päringud järjekorda ja järgi vastuse Retry-After päist.
Korduskatsete reeglid
Oota vähemalt Retry-After päises määratud arv sekundeid. Kirjutamise kordamisel säilita sama päringu sisu ja Idempotency-Key väärtus.
Vastus
{
  "error": {
    "code": "capacity.queue_full",
    "fields": null,
    "message": "The API is busy. Please retry shortly."
  },
  "meta": {
    "request_id": "example-request"
  }
}

429capacity.wait_timeoutAPI järjekorras ootamise aeg sai läbi; päringu täitmine ei ole alanud.
Mida teha
Pane päringud järjekorda ja järgi vastuse Retry-After päist.
Korduskatsete reeglid
Oota vähemalt Retry-After päises määratud arv sekundeid. Kirjutamise kordamisel säilita sama päringu sisu ja Idempotency-Key väärtus.
Vastus
{
  "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.exceededPäringusagedus ületab kehtivat piirangut.
Mida teha
Pane päringud järjekorda ja järgi vastuse Retry-After päist.
Korduskatsete reeglid
Oota vähemalt Retry-After päises määratud arv sekundeid. Kirjutamise kordamisel säilita sama päringu sisu ja Idempotency-Key väärtus.
Vastus
{
  "error": {
    "code": "rate_limit.exceeded",
    "fields": null,
    "message": "The request rate limit has been exceeded."
  },
  "meta": {
    "request_id": "example-request"
  }
}

500internal.errorIlmnes ootamatu teenuseviga.
Mida teha
Oota enne päringu kordamist veidi. Kui viga 500 kordub, võta ühendust Shopently tehnilise toega ja lisa päringu ID.
Korduskatsete reeglid
Andmete lugemist võid lühikese pausi järel uuesti proovida. Kirjutamise kordamisel kasuta sama Idempotency-Key väärtust ja jäta päringu sisu muutmata.
Vastus
{
  "error": {
    "code": "internal.error",
    "fields": null,
    "message": "An unexpected error occurred."
  },
  "meta": {
    "request_id": "example-request"
  }
}

502gateway.bad_responseLüüs ei saanud API-lt kehtivat vastust.
Mida teha
Säilita päringu identifikaator. Ebaõnnestunud vastus ei tõesta, et muudatust ei rakendatud.
Korduskatsete reeglid
Kasuta piiratud arvu kasvava viivitusega korduskatseid; korda sama loogilist muudatust algse Idempotency-Key ja sisuga.
Vastus
{
  "error": {
    "code": "gateway.bad_response",
    "fields": null,
    "message": "The API gateway could not obtain a valid response."
  },
  "meta": {
    "request_id": "example-request"
  }
}

503service.unavailableAPI ei suuda ajutiselt päringut töödelda.
Mida teha
Kui vastus sisaldab Retry-After päist, oota enne uut katset selles määratud arv sekundeid. Muidu oota veidi. Kui viga püsib, võta ühendust Shopently tehnilise toega ja lisa päringu ID.
Korduskatsete reeglid
Proovi uuesti pärast eespool kirjeldatud ooteaega. Kirjutamise kordamisel kasuta sama Idempotency-Key väärtust ja jäta päringu sisu muutmata.
Vastus
{
  "error": {
    "code": "service.unavailable",
    "fields": null,
    "message": "The API is temporarily unavailable."
  },
  "meta": {
    "request_id": "example-request"
  }
}

504gateway.timeoutLüüsi ooteaeg API vastusele lõppes.
Mida teha
Kui päring muutis andmeid, kontrolli, kas muudatused salvestati poes. Vastuse puudumine ei tähenda, et salvestamine ebaõnnestus. Kui viga püsib, võta ühendust Shopently tehnilise toega ja lisa päringu ID.
Korduskatsete reeglid
Andmete lugemist võid lühikese pausi järel uuesti proovida. Kirjutamise kordamisel kasuta sama Idempotency-Key väärtust ja jäta päringu sisu muutmata.
Vastus
{
  "error": {
    "code": "gateway.timeout",
    "fields": null,
    "message": "The API gateway timed out."
  },
  "meta": {
    "request_id": "example-request"
  }
}