Saltar a contenido

Respuestas

Los métodos que devuelven JSON usan el mismo sobre:

{
  "result": true,
  "entities": [
    { "shippingId": 8800061, "totalValue": 11.00 }
  ],
  "messages": [
    "Record created successfully",
    "Time execution:1564 ms."
  ],
  "notificationType": 3
}
Campo Tipo Significado
result booleano true cuando la petición se procesó
entities arreglo Los datos que devuelve el método. Su contenido se describe en la página de cada método
messages arreglo de texto Errores, advertencias e información sobre la petición
notificationType número Resultado de la petición (ver la tabla siguiente)

notificationType

Valor Significado Qué hacer
1 Error La petición no se completó. Lea messages, corrija los datos e intente de nuevo
2 Completada con advertencias La petición se completó. Lea messages: algo puede requerir su atención
3 Exitosa La petición se completó
4 Información La petición se procesó. Lea messages

Revise siempre notificationType y messages

Una respuesta HTTP 200 no significa que la petición se completó. Revise notificationType en cada respuesta y guarde messages en sus registros: es lo primero que le pedirá nuestro equipo de soporte.

Códigos HTTP

Código Cuándo
200 La petición llegó al método. Revise notificationType
400 Falta un parámetro o no es válido. El cuerpo lista cada campo en errors (ver abajo)
401 El token falta, no es válido o venció. Vea Autenticación
403 El token es válido pero no tiene acceso a ese método o a esa información

Errores de validación

Cuando falta un parámetro obligatorio o un valor está fuera de rango, el API responde 400 con este cuerpo en lugar del sobre anterior:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "UserId": [ "UserId is required" ]
  }
}