Earráidí agus athshlánú

Úsáid cóid earráide chobhsaí chun cinneadh a dhéanamh idir ceartú, fanacht agus atriail.

Cad atá le déanamh

Bunaigh an loighic ar an stádas HTTP agus error.code, ní ar error.message atá scríofa do dhaoine.
Éilíonn 401 fíordheimhniú bailí; éilíonn 403 athrú rochtana nó plean; éilíonn 409 seiceáil ar an oibríocht chontrártha nó ar leagan na hacmhainne.

Rochtain diúltaithe agus atrialacha

401: Ní chiallaíonn 401 i gcónaí go bhfuil an comhartha imithe in éag. Má tá, faigh ceann nua agus déan an léamh arís uair amháin ar a mhéad. Má thugann fáil an chomhartha 401 ar ais, seiceáil an eochair agus stop iarrachtaí uathoibríocha.
403: Le 403, seiceáil ceadanna, srianta IP agus an plean. Ní chuireann comhartha nua rochtain chúlghairthe ar ais.

Fíordheimhniú

Polasaí atrialach

I gcás teipeanna sealadacha, úsáid líon teoranta atrialacha le moill mhéadaitheach agus athrú randamach.
Cloígh le Retry-After nuair a thugtar é.
Má théann scríobh thar am, d'fhéadfadh a thoradh a bheith anaithnid: coinnigh an Idempotency-Key céanna agus an t-iarratas gan athrú agus an oibríocht loighciúil chéanna á hatriail.
Míníonn an chatalóg thíos gach cód earráide foilsithe.

Scríobh sábháilte

Teorainneacha ráta

422 / 409

I gcás praghsanna, tugann formáid airgeadra nó beachtas suime neamhbhailí 422 request.validation_failed ar ais.
Tugann cód airgeadra bailí nach ionann é agus airgeadra an liosta praghsanna roghnaithe 409 resource.version_conflict ar ais.
Seiceáil an comhthéacs agus na leaganacha sula ndéanann tú iarracht eile.

Catalóg earráidí

400request.malformedNí féidir an t-iarratas a pharsáil.

Cad atá le déanamh: Seiceáil comhréir JSON, ionchódú URL agus struchtúr an iarratais.
Polasaí atrialach: Atriail tar éis an t-iarratas a cheartú.

JSON

{
  "error": {
    "code": "request.malformed",
    "fields": null,
    "message": "The request could not be read."
  },
  "meta": {
    "request_id": "example-request"
  }
}

401authentication.invalid_credentialsTá an eochair API nó an comhartha rochtana neamhbhailí, imithe in éag nó cúlghairthe.

Cad atá le déanamh: Seiceáil URL an tsiopa agus na dintiúir. Faigh comhartha úr le heochair API ghníomhach.
Polasaí atrialach: Atriail tar éis an fíordheimhniú a cheartú; seachain iarratais arís agus arís le comhartha neamhbhailí.

JSON

{
  "error": {
    "code": "authentication.invalid_credentials",
    "fields": null,
    "message": "The credentials are invalid."
  },
  "meta": {
    "request_id": "example-request"
  }
}

401authentication.requiredTá an ceanntásc Authorization riachtanach ar iarraidh nó tá a scéim mícheart.

Cad atá le déanamh: Úsáid ApiKey agus comhartha á iarraidh agus Bearer d'oibríochtaí acmhainní.
Polasaí atrialach: Atriail tar éis an ceanntásc ceart a chur ar fáil.

JSON

{
  "error": {
    "code": "authentication.required",
    "fields": null,
    "message": "Authentication is required."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403authorization.client_ip_unverifiedNíorbh fhéidir leis an tseirbhís seoladh IP iontaofa an chliaint a fháil.

Cad atá le déanamh: Iarr ar oibreoir an tsiopa an bealach isteach a sheiceáil. Ná cuir ceanntásca ar aghaidh isteach tú féin.
Polasaí atrialach: Atriail tar éis an bealach ceangail iontaofa a athbhunú.

JSON

{
  "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_allowedTá an seoladh IP foinseach lasmuigh de liosta seoltaí ceadaithe na heochrach.

Cad atá le déanamh: Úsáid seoladh foinseach ceadaithe nó iarr ar riarthóir údaraithe liosta IP na heochrach a athrú.
Polasaí atrialach: Ná hatriail go dtí go gceadaítear an seoladh.

JSON

{
  "error": {
    "code": "authorization.ip_not_allowed",
    "fields": null,
    "message": "Access from this IP address is not allowed."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403authorization.scope_deniedNíl cead éifeachtach atá riachtanach don oibríocht seo ag an eochair.

Cad atá le déanamh: Seiceáil ceadanna riachtanacha agus coinníollacha na hoibríochta, ceadanna na heochrach agus rochtain an eisitheora.
Polasaí atrialach: Atriail tar éis do riarthóir údaraithe an rochtain riachtanach a dheonú.

JSON

{
  "error": {
    "code": "authorization.scope_denied",
    "fields": null,
    "message": "The required permission has not been granted."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.api_disabledTá rochtain API díchumasaithe don siopa seo.

Cad atá le déanamh: Iarr ar úinéir an tsiopa an plean gníomhach agus infhaighteacht API a sheiceáil.
Polasaí atrialach: Ná hatriail go dtí go gcumasaítear rochtain API.

JSON

{
  "error": {
    "code": "entitlements.api_disabled",
    "fields": null,
    "message": "API access is disabled for this store."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.limit_exceededSháródh an t-athrú teorainn sa phlean reatha.

Cad atá le déanamh: Seiceáil teorainn na hacmhainne agus coigeartaigh an t-athrú nó an plean.
Polasaí atrialach: Atriail tar éis an teorainn a réiteach; úsáid eochair idimpitéinse nua má athraíonn an t-iarratas.

JSON

{
  "error": {
    "code": "entitlements.limit_exceeded",
    "fields": null,
    "message": "The operation exceeds a plan limit."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.operation_disabledNí chuimsíonn an plean reatha an oibríocht seo.

Cad atá le déanamh: Seiceáil an plean íosta atá léirithe don oibríocht.
Polasaí atrialach: Atriail nuair a cheadaíonn an plean an oibríocht agus nuair atá na ceadanna riachtanacha ag an eochair.

JSON

{
  "error": {
    "code": "entitlements.operation_disabled",
    "fields": null,
    "message": "The current plan does not allow this operation."
  },
  "meta": {
    "request_id": "example-request"
  }
}

403entitlements.resource_blockedBlocálann teorainn plean an acmhainn áirithe seo.

Cad atá le déanamh: Iarr ar an úinéir srian plean na hacmhainne a réiteach.
Polasaí atrialach: Ná déan an t-iarratas céanna arís agus an acmhainn blocáilte.

JSON

{
  "error": {
    "code": "entitlements.resource_blocked",
    "fields": null,
    "message": "A plan limit blocks access to this resource."
  },
  "meta": {
    "request_id": "example-request"
  }
}

404resource.not_foundTá an acmhainn ar iarraidh, scriosta nó níl sí ar fáil faoin aitheantóir tugtha.

Cad atá le déanamh: Seiceáil an siopa, cosán na hacmhainne agus an t-aitheantóir. Úsáid aitheantóirí a thugann an siopa seo ar ais.
Polasaí atrialach: Ná hatriail ach tar éis an sprioc a cheartú nó a dheimhniú go bhfuil sí ann.

JSON

{
  "error": {
    "code": "resource.not_found",
    "fields": null,
    "message": "The resource was not found."
  },
  "meta": {
    "request_id": "example-request"
  }
}

405request.method_not_allowedNí thacaíonn an críochphointe leis an modh HTTP seo.

Cad atá le déanamh: Úsáid an modh doiciméadaithe; léiríonn an ceanntásc Allow na modhanna tacaithe.
Polasaí atrialach: Ná hatriail an modh gan tacaíocht.

JSON

{
  "error": {
    "code": "request.method_not_allowed",
    "fields": null,
    "message": "This method is not supported for this resource."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409idempotency.key_reusedBaineann an eochair idimpitéinse seo le hiarratas eile.

Cad atá le déanamh: Aimsigh an oibríocht bhunaidh. Ná húsáid eochair nua ach le haghaidh oibríocht loighciúil nua d'aon ghnó.
Polasaí atrialach: Ná hatriail ábhar athraithe leis an eochair chontrártha.

JSON

{
  "error": {
    "code": "idempotency.key_reused",
    "fields": null,
    "message": "This idempotency key was used with a different request."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.already_existsTá luach uathúil i gcoimhlint le hacmhainn atá ann cheana.

Cad atá le déanamh: Léigh an acmhainn atá ann agus socraigh an úsáidfear í nó an roghnófar luach uathúil eile.
Polasaí atrialach: Ná déan an cruthú contrártha céanna arís.

JSON

{
  "error": {
    "code": "resource.already_exists",
    "fields": null,
    "message": "A resource with these unique values already exists."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.in_useBraitheann acmhainní eile ar an acmhainn seo fós.

Cad atá le déanamh: Athbhreithnigh na spleáchais agus bain nó athraigh iad le hoibríochtaí tacaithe roimh scriosadh.
Polasaí atrialach: Atriail tar éis na spleáchais a réiteach.

JSON

{
  "error": {
    "code": "resource.in_use",
    "fields": null,
    "message": "The resource is still in use."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.state_conflictCuireann an staid ghnó reatha cosc ar an athrú seo.

Cad atá le déanamh: Léigh an staid reatha agus roghnaigh aistriú gnó bailí.
Polasaí atrialach: Ná brúigh an t-athrú contrártha go huathoibríoch agus ná seol arís agus arís é.

JSON

{
  "error": {
    "code": "resource.state_conflict",
    "fields": null,
    "message": "The current resource state does not allow this operation."
  },
  "meta": {
    "request_id": "example-request"
  }
}

409resource.version_conflictD'athraigh scríobh eile an acmhainn tar éis an leagain a léigh tú.

Cad atá le déanamh: Léigh an staid is déanaí, réitigh d'athrú agus seol expected_version nua.
Polasaí atrialach: Úsáid eochair idimpitéinse nua don oibríocht leasaithe; ná forscríobh gan seiceáil.

JSON

{
  "error": {
    "code": "resource.version_conflict",
    "fields": null,
    "message": "The resource version has changed."
  },
  "meta": {
    "request_id": "example-request"
  }
}

413request.too_largeSáraíonn an t-iarratas an teorainn méide.

Cad atá le déanamh: Laghdaigh an t-ábhar nó roinn an obair ina hoibríochtaí aonair tacaithe.
Polasaí atrialach: Atriail oibríochtaí bailí níos lú lena n-eochracha idimpitéinse féin.

JSON

{
  "error": {
    "code": "request.too_large",
    "fields": null,
    "message": "The request exceeds the size limit."
  },
  "meta": {
    "request_id": "example-request"
  }
}

415request.unsupported_media_typeNí thacaítear leis an gcineál meáin nó leis an ionchódú ábhair.

Cad atá le déanamh: Le haghaidh scríobh JSON, úsáid Content-Type: application/json agus corp neamh-chomhbhrúite tacaithe.
Polasaí atrialach: Atriail tar éis cineál an mheáin nó an t-ionchódú a cheartú.

JSON

{
  "error": {
    "code": "request.unsupported_media_type",
    "fields": null,
    "message": "The request media type or encoding is not supported."
  },
  "meta": {
    "request_id": "example-request"
  }
}

422request.validation_failedTeipeann ar réimse nó paraiméadar amháin nó níos mó sa bhailíochtú.

Cad atá le déanamh: Scrúdaigh error.fields, ansin seiceáil réimsí riachtanacha, cead null, aitheantóirí agus luachanna ceadaithe.
Polasaí atrialach: Atriail iarratas ceartaithe; is oibríocht loighciúil nua é scríobh athraithe.

JSON

{
  "error": {
    "code": "request.validation_failed",
    "fields": null,
    "message": "Some request parameters are invalid."
  },
  "meta": {
    "request_id": "example-request"
  }
}

429capacity.queue_fullTá an scuaine ghearr API lán; níor tosaíodh ar an iarratas a rith.

Cad atá le déanamh: Cuir iarratais i scuaine agus cloígh leis an gceannteideal freagra Retry-After.
Polasaí atrialach: Fan ar a laghad Retry-After soicind agus cuir moill randamach leis. Coinnigh an eochair agus an t-ábhar bunaidh agus scríobh á hatriail.

JSON

{
  "error": {
    "code": "capacity.queue_full",
    "fields": null,
    "message": "The API is busy. Please retry shortly."
  },
  "meta": {
    "request_id": "example-request"
  }
}

429capacity.wait_timeoutTá an t-am feithimh sa scuaine API caite; níor tosaíodh ar an iarratas a rith.

Cad atá le déanamh: Cuir iarratais i scuaine agus cloígh leis an gceannteideal freagra Retry-After.
Polasaí atrialach: Fan ar a laghad Retry-After soicind agus cuir moill randamach leis. Coinnigh an eochair agus an t-ábhar bunaidh agus scríobh á hatriail.

JSON

{
  "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.exceededSáraíonn ráta na n-iarratas an teorainn infheidhme.

Cad atá le déanamh: Cuir iarratais i scuaine agus cloígh leis an gceannteideal freagra Retry-After.
Polasaí atrialach: Fan ar a laghad Retry-After soicind agus cuir moill randamach leis. Coinnigh an eochair agus an t-ábhar bunaidh agus scríobh á hatriail.

JSON

{
  "error": {
    "code": "rate_limit.exceeded",
    "fields": null,
    "message": "The request rate limit has been exceeded."
  },
  "meta": {
    "request_id": "example-request"
  }
}

500internal.errorTharla earráid seirbhíse gan choinne.

Cad atá le déanamh: Taifead aitheantóir an iarratais agus déan teagmháil leis an oibreoir má leanann an earráid; ná cuir dintiúir sna logaí.
Polasaí atrialach: Úsáid atrialacha teoranta le moill mhéadaitheach. Don scríobh, coinnigh an eochair idimpitéinse bhunaidh agus ábhar gan athrú.

JSON

{
  "error": {
    "code": "internal.error",
    "fields": null,
    "message": "An unexpected error occurred."
  },
  "meta": {
    "request_id": "example-request"
  }
}

502gateway.bad_responseNí bhfuair an geata freagra bailí ón API.

Cad atá le déanamh: Coinnigh aitheantóir an iarratais. Ní chruthaíonn freagra teipthe nár cuireadh scríobh i bhfeidhm.
Polasaí atrialach: Úsáid atrialacha teoranta le moill mhéadaitheach; déan an scríobh loighciúil céanna leis an Idempotency-Key agus an t-ábhar bunaidh.

JSON

{
  "error": {
    "code": "gateway.bad_response",
    "fields": null,
    "message": "The API gateway could not obtain a valid response."
  },
  "meta": {
    "request_id": "example-request"
  }
}

503service.unavailableNí féidir leis an API an t-iarratas a láimhseáil go sealadach.

Cad atá le déanamh: Cloígh le Retry-After má tá sé ann agus coinnigh aitheantóir an iarratais má leanann an briseadh.
Polasaí atrialach: Úsáid atrialacha teoranta le moill mhéadaitheach agus randamach; coinnigh an eochair agus an t-ábhar agus an scríobh céanna á hatriail.

JSON

{
  "error": {
    "code": "service.unavailable",
    "fields": null,
    "message": "The API is temporarily unavailable."
  },
  "meta": {
    "request_id": "example-request"
  }
}

504gateway.timeoutChuaigh an geata thar am agus é ag fanacht leis an API.

Cad atá le déanamh: Coinnigh aitheantóir an iarratais agus caith le toradh an scríofa mar thoradh anaithnid.
Polasaí atrialach: Úsáid atrialacha teoranta le moill mhéadaitheach; athúsáid an eochair idimpitéinse bhunaidh agus ábhar gan athrú don scríobh.

JSON

{
  "error": {
    "code": "gateway.timeout",
    "fields": null,
    "message": "The API gateway timed out."
  },
  "meta": {
    "request_id": "example-request"
  }
}