Scéimeanna sonraí: Samhlacha comhroinnte

codeTeaghránRiachtanach

Cód cobhsaí atá inléite ag meaisín.

Srianta

enum

["request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]

Sampla: "authentication.invalid_credentials"

fieldsEagar <FieldError > | nullRoghnach

Earráidí bailíochtaithe réimsí aonair.

Sampla: null

messageTeaghránRiachtanach

Míniú do dhaoine; úsáid an cód earráide i loighic cláir.

Sampla: "The credentials are invalid."

Réimsí breise: Níl

dataMutationData Riachtanach

Sampla freagra · MutationData.

Sampla: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Riachtanach

Meiteashonraí an fhreagra.

Sampla: {"request_id":"example"}

Réimsí breise: Níl

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

Sampla: "en"

market_codeTeaghránRiachtanach

Cód margaidh a thugann an críochphointe comhthéacs.

Sampla: "PL"

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Sampla: "example"

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

Sampla: "example"

Réimsí breise: Níl

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

Sampla: "en"

market_codeTeaghránRiachtanach

Cód margaidh a thugann an críochphointe comhthéacs.

Sampla: "PL"

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Sampla: "example"

paginationPagination Riachtanach

Meiteashonraí leathanaithe le cúrsóir.

Sampla: {"has_more":false,"limit":20,"next_cursor":null}

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

Sampla: "example"

Réimsí breise: Níl

errorApiError Riachtanach

Eolas earráide struchtúrtha.

Sampla: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta Riachtanach

Meiteashonraí an fhreagra.

Sampla: {"request_id":"example-request"}

Réimsí breise: Níl

codeTeaghránRiachtanach

Cód cobhsaí atá inléite ag meaisín.

Srianta

enum

["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]

fieldTeaghránRiachtanach

Réimse a bhaineann le hearráid bhailíochtaithe.

minLength: 1maxLength: 128

locationTeaghránRiachtanach

Eolas suímh.

Srianta

enum

["path", "query", "header", "body"]

Réimsí breise: Níl

amountTeaghránRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Sampla: "0.00"

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

pattern

"^[A-Z]{3}$"

Sampla: "PLN"

minor_unitsSlánuimhirRiachtanach

Líon na n-ionad deachúlach a úsáideann an t-airgeadra.

minimum: 0maximum: 4

Sampla: 2

Réimsí breise: Níl

deletedLuach BooleRiachtanach

Ar cuireadh an scriosadh i bhfeidhm.

Sampla: false

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (MutationData).

Sampla: "example"

versionSlánuimhir | nullRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 1

Réimsí breise: Níl

paginationPagination Riachtanach

Meiteashonraí leathanaithe le cúrsóir.

Sampla: {"has_more":false,"limit":20,"next_cursor":null}

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

Sampla: "example"

Réimsí breise: Níl

has_moreLuach BooleRiachtanach

An bhfuil leathanach eile ar fáil.

Sampla: false

limitSlánuimhirRiachtanach

Uaslíon taifead ar an leathanach seo.

minimum: 1maximum: 100

Sampla: 20

next_cursorTeaghrán | nullRiachtanach

Luach leanúna don chéad leathanach eile, nó null.

Sampla: null

Réimsí breise: Níl

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

Sampla: "example"

Réimsí breise: Níl