Marcar una orden como facturada
Método utilizado para marcar una orden como facturada para una tienda en particular.
PUT {env}/1/orders/:order_id/billingHeaders
{
"Authorization": "Bearer {access_token}",
"X-Shop-Id": "12345"
}| Parámetro | Tipo | Requerido | Valores aceptados | Descripción |
|---|---|---|---|---|
Authorization | string | Si | Bearer + access_token | Token obtenido mediante client_id y client_secret. |
X-Shop-Id | string | Si | String numérico | Identificador único de la tienda a la cual se desea actualizar la orden. |
Body
{
"billing_invoice_invoiced": true,
"billing_invoice_link": "https://some-app.com/some-link",
"billing_invoice_reference_id": "some-reference-id"
}| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
billing_invoice_invoiced | bool | No | Indica si la orden esta facturada o no. |
billing_invoice_link | string | Si | Corresponde al link de la factura de la orden. Debe comenzar con http:// o https:// y debe poder accederse públicamente. |
billing_invoice_reference_id | string | Si | Corresponde al ID de facturación para dicha factura. |
Response exitosa: 201 Created
En caso de éxito, retorna HTTP Code 201 con payload vacío.
{}Responses de error
En caso de que la respuesta HTTP no sea 201, entonces se debe considerar haber obtenido una respuesta de error.
| Atributo | Tipo | Descripción |
|---|---|---|
status | int | Http code de respuesta. |
code | string | Código de error, indica la naturaleza del mismo. |
msg | string | Mensaje de error. |
Ejemplo response 400 Bad Request si algún parámetro de entrada requerido no es enviado:
{
"status": 400,
"code": "param_required",
"msg": "invalid <param_name>. the value is required"
}Ejemplo response 400 Bad Request si algún parámetro de entrada es inválido:
{
"status": 400,
"code": "param_invalid",
"msg": "invalid <param_name>. the value is invalid"
}Ejemplo response 400 Bad Request si el body que se envía es un JSON inválido:
{
"status": 400,
"code": "request_error",
"msg": "invalid payload format"
}Ejemplo response 400 Bad Request si el path es inválido:
{
"status": 400,
"code": "request_error",
"msg": "invalid path"
}Ejemplo response 404 Not Found si no existe la orden para la tienda especificada:
{
"status": 404,
"code": "not_found",
"msg": "resource not found"
}Ejemplo response 401 Unauthorized:
{
"status": 401,
"code": "error",
"msg": "Unauthorized"
}Ejemplo response 500 Internal Server Error:
{
"status": 500,
"code": "server_error",
"msg": "something went wrong"
}