Saltar al contenido principal

POST | /

Función que Realiza

Crea un nuevo despacho pendiente sin estar asignado a una solicitud de merch.


Funcionamiento

  • URL Completa: {domain}/api/v1/dispatch/
  • Acción: POST
  • Requiere Api-Key?: Si
  • Requiere una Sesión?: Si
  • Recibe datos mediante: Body
    • Cantidad de datos: 3
  • Responde con contenido?: No
  • Responde únicamente con código de estado?: Si
    • Código: 201 | Created
  • Códigos de error: Vea la sección Errores

Contenido que se recibe por Body

Estructura del JSON: {"parámetro": "tipo de dato"}

{
"assignedMerchId": "String",
"details?": "String [Max 180]" | null,
"targetDate": "Date(YYYY-MM-DD)"
}

Códigos de Error

HTTP CodeCustom CodeMessage
422INVALID_REQUEST_DATALos datos enviados son inválidos o insuficientes.
422TARGET_DATE_CANNOT_BE_BEFORE_CURRENTLa fecha objetivo no puede ser menor a la actual.
422INVALID_IDSLas ids ingresadas son inválidas.
422USER_IS_MERCHLa id de usuario ingresada pertenece a un merch.
422USER_IS_NOT_MERCHLa id de merch ingresada no pertenece a un usuario merch.
404MERCH_NOT_FOUNDNo se encontró un merch con esa id.
404USER_NOT_FOUNDNo se encontró un usuario con esa id.
500UNEXPECTED_ERRORNo se encontró el usuario insertado mediante la sesión.
401INVALID_API_KEYLa API Key proporcionada no es válida.
401INVALID_SESSIONLa sesión no es válida o ha expirado.
401INSUFFICIENT_PERMISSIONSNo tienes los permisos suficientes para acceder.