Saltar al contenido
ShopentlyLearn

Solicitudes y respuestas

Interpreta conjuntamente el estado HTTP, los tipos del contenido JSON y los metadatos de la solicitud.

Solicitud

Content-Type: application/json
Envía las escrituras JSON con Content-Type: application/json.
data · meta
Las respuestas correctas contienen data y meta; las respuestas de colecciones incluyen además información de paginación.
error.code · error.message
Los errores contienen error.code, error.message e información de campos cuando corresponde.

Tipos de datos

  • Obligatorio y nullable son propiedades independientes.
  • Un campo obligatorio puede contener null si su esquema lo permite.
  • Conserva los tipos JSON booleano, entero, cadena y null sin conversiones automáticas.
  • Los importes monetarios son cadenas decimales; no calcules precios mediante coma flotante binaria.

64-bit · expected_version

  • Algunas versiones para controlar cambios simultáneos utilizan enteros con signo de 64 bits.
  • Un cliente JavaScript debe procesar JSON sin pérdida de precisión para los valores superiores a Number.MAX_SAFE_INTEGER y enviar la representación entera original.
  • No redondees una versión ni la conviertas en una cadena JSON.

Cabeceras

Cache-ControlCadena de textoOpcional

Política de caché de la respuesta.

const: "no-store"
X-Correlation-IDCadena de textoOpcional

Identificador para rastrear esta solicitud HTTP.

WWW-AuthenticateCadena de textoOpcional

Esquema de autenticación exigido por el servidor.

AllowCadena de textoOpcional

Métodos HTTP admitidos por este recurso.

Retry-AfterNúmero enteroOpcional

Espera mínima antes de reintentar, en segundos.

minimum: 0
LocationCadena de textoOpcional

URL relativa del recurso creado.