Send orden de compra

The following endpoint is used to send a orden de compra to a customer from the Hyfin application. The orden de compra will be sent via text message, email or both based on the notification options set on the customer record.

Note: Any attempts to send the same customer the same orden de compra within a 5 minute period will be blocked.

Punto Final

The following endpoint can be used to send a orden de compra. You must replace the {base_url} variable and replace the {site_id} variable with the site id that was provided when the site was created.

POST

{base_url}/api/v3.1/site/{site_id}/orden de compra/send

Solicitud

Campo

Tipo

Requerido

Descripción

external_id

String

El id único orden de compra del sistema/base de datos fuente.

Sample Request

			
				{
  "external_id": "39772921"
}

Respuesta

Campo

Tipo

Descripción

success

Boolean

Si el orden de compra se envió correctamente.

action

String

Will only be returned if `success` is `true`.
One of `updated`

errors

String [ ]

A list of errors. Will only be returned if `success` is `false`.

Sample Response (Successful)

			
				{
  "success": true,
  "action": "updated"
}

Sample Response (Failed)

			
				{
  "success": false,
  "errors": [
    "Duplicate email sent < 300 sec. ago"
  ]
}