Skip to Content
Referencia de la APIOrdenesMarcar como facturada

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/billing

Headers

{ "Authorization": "Bearer {access_token}", "X-Shop-Id": "12345" }
ParámetroTipoRequeridoValores aceptadosDescripción
AuthorizationstringSiBearer + access_tokenToken obtenido mediante client_id y client_secret.
X-Shop-IdstringSiString numéricoIdentificador ú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" }
NombreTipoOpcionalDescripción
billing_invoice_invoicedboolNoIndica si la orden esta facturada o no.
billing_invoice_linkstringSiCorresponde al link de la factura de la orden. Debe comenzar con http:// o https:// y debe poder accederse públicamente.
billing_invoice_reference_idstringSiCorresponde 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.

AtributoTipoDescripción
statusintHttp code de respuesta.
codestringCódigo de error, indica la naturaleza del mismo.
msgstringMensaje 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" }