Pedidos
Pedidos de todos los canales: ítems, totales, estado y pago. El listado devuelve los cambios en orden de confirmación; el estado sigue las reglas de la tienda.
Pedidos
Objetos
Order
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
numberstring o nullobligatorioNúmero del pedido que ven el cliente y el personal; null mientras el pedido aún no lo tiene.
channelstringobligatorioDe dónde vino el pedido: web — la tienda online; pos — la caja; marketplace — un marketplace como Mercado Libre; external — un sistema de gestión de la tienda; manual — un borrador de pedido del personal o de una aplicación; subscription — un día de un plan de comidas.
- Valores:
webposmarketplaceexternalmanualsubscription
app_idinteger o nullobligatorioLa aplicación que confirmó el pedido desde su borrador (/v1/draft-orders), su id de /v1/me; null en los pedidos de la tienda online, la caja o el personal.
location_idintegerobligatorioLocal que atiende el pedido: el punto de retiro o el local del que se descuenta el stock.
legal_entity_idinteger o nullobligatorioRazón social a nombre de la que se hizo la venta (/v1/legal-entities); null — la venta no está repartida entre razones sociales, y su razón social es la predeterminada de la tienda.
statusstringobligatorioEstado del pedido: un código de la lista de estados de la tienda (/v1/order-statuses). La tienda puede agregar sus propios estados; status_group da el significado permanente.
status_groupstringobligatorioSignificado permanente del estado: pos_open — cuenta abierta en la caja; placed — realizado; pending_payment — esperando el pago; paid — pagado; confirmed — aceptado por la tienda; preparing — en preparación; ready — listo; ready_for_pickup — listo para retirar; out_for_delivery — en camino; delivery_failed — entrega fallida; delivered — entregado; completed — completado; cancelled — cancelado; refunded — reembolsado.
- Valores:
pos_openplacedpending_paymentpaidconfirmedpreparingreadyready_for_pickupout_for_deliverydelivery_faileddeliveredcompletedcancelledrefunded
payment_statusstringobligatorioPago del pedido: unpaid — sin pagar; partial — pagado en parte; paid — pagado; partially_refunded — reembolsado en parte; refunded — reembolsado.
- Valores:
unpaidpartialpaidpartially_refundedrefunded
sale_typestringobligatorioretail — venta a un cliente; staff — venta a un empleado; wholesale — venta mayorista.
- Valores:
retailstaffwholesale
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
items_totalintegerobligatorioSuma de los ítems antes del descuento del pedido.
discountintegerobligatorioDescuento del pedido sobre los productos: la suma de applied_discounts[].amount y de items[].discount.
applied_discountsarray de objectobligatorioDe qué se compone el descuento sobre los productos: el registro de descuentos aplicados. Las filas se reescriben cuando se recalcula el pedido: un id vive hasta entonces.
Campos · 8
idintegerobligatorioFila del registro; items[].discount_allocations[].applied_discount_id apunta a ella.
sourcestringobligatorioCómo llegó el descuento al pedido: automatic — una regla de la tienda; pick — una regla que marcó el cajero; promocode — el código promocional del comprador; manual — un descuento manual del cajero; offline_capture — la diferencia entre una venta sin conexión de la caja y el cálculo del servidor, no una decisión del vendedor; loyalty_program — un programa de fidelización; external_pos — la caja externa que hizo la venta.
- Valores:
promocodeautomaticpickmanualoffline_captureloyalty_programexternal_pos
kindstring o nullobligatorioPor qué es el descuento: promo — una promoción; employee — para el personal; expiry — rebaja por vencimiento; payment_method — por el medio de pago; markdown — rebaja por el estado del producto; goodwill — una atención al comprador; comp — invita la casa; other — otro motivo. null — un descuento de la caja externa, una diferencia sin conexión o un descuento anterior a este eje.
- Valores:
promoemployeeexpirypayment_methodmarkdowngoodwillcompothernull
nameobject o nullobligatorioNombre de la regla o del programa de fidelización al momento de la venta; null en un código promocional, un descuento manual, una diferencia sin conexión y la caja externa.
codestring o nullobligatorioEl código promocional que ingresó el comprador; null — no es un descuento por código.
reasonstring o nullobligatorioEl motivo del descuento manual en palabras del cajero; null en los demás.
order_item_idinteger o nullobligatorioEl ítem rebajado por separado; null — un descuento sobre el pedido, sus partes por ítem están en items[].discount_allocations.
amountintegerobligatorioImporte del descuento.
delivery_costintegerobligatorioEnvío a pagar, después del descuento sobre el envío.
delivery_discountintegerobligatorioDescontado del envío: el precio del envío antes del descuento es delivery_cost + delivery_discount.
delivery_discountsarray de objectobligatorioDe qué se compone el descuento sobre el envío: la suma de amount es igual a delivery_discount.
Campos · 6
idintegerobligatorioFila del registro de descuentos del envío.
sourcestringobligatorioCómo llegó el descuento al pedido: los valores de applied_discounts[].source.
- Valores:
promocodeautomaticpickmanualoffline_captureloyalty_programexternal_pos
kindstring o nullobligatorioPor qué es el descuento: los valores de applied_discounts[].kind.
- Valores:
promoemployeeexpirypayment_methodmarkdowngoodwillcompothernull
nameobject o nullobligatorioNombre de la regla al momento de la venta; null — un descuento por código promocional.
codestring o nullobligatorioEl código promocional que ingresó el comprador; null — no es un descuento por código.
amountintegerobligatorioImporte del descuento sobre el envío.
delivery_tax_linesarray de object o nullobligatorioImpuesto del envío según la clase impositiva predeterminada de la tienda: su parte del impuesto de su alícuota en tax_lines; null cuando no hay envío a pagar o el impuesto es desconocido.
Campos · 6
regimestringobligatorioQué impuesto: vat — impuesto al valor agregado (IVA); income — ganancias; turnover — Ingresos Brutos; municipal — tasas municipales; internal — impuestos internos; social — seguridad social; other — otro. El impuesto de una venta es vat: la clase impositiva del producto clasifica el IVA.
- Valores:
vatincometurnovermunicipalinternalsocialother
kindstringobligatoriotaxed — a la alícuota; exempt — exento por ley; untaxed — no gravado. Las líneas exempt y untaxed tienen rate_bps 0 y amount 0: el importe está en base.
- Valores:
taxedexemptuntaxed
rate_bpsintegerobligatorioAlícuota en puntos básicos: 2100 es 21 %.
baseintegerobligatorioBase imponible, sin el impuesto. Los precios incluyen impuestos: base + amount es lo que pagó el cliente por esta parte.
amountintegerobligatorioImporte del impuesto. El impuesto de una venta se calcula por alícuota para todo el pedido, la base redondeada a la unidad más cercana y el impuesto como resto; los ítems y el envío reciben partes de él, así sus líneas suman la línea del pedido.
jurisdictionstring o nullobligatorioProvincia o municipio para los impuestos que lo requieren (turnover, municipal); si no, null.
platform_discountintegerobligatorioDescuento que paga la plataforma agregadora: no reduce la venta de la tienda.
platform_service_feeintegerobligatorioTarifa de servicio de la plataforma agregadora: forma parte de total, pero no es venta de la tienda.
platform_delivery_feeintegerobligatorioEnvío que hace la plataforma agregadora: forma parte de total, pero no es venta de la tienda.
totalintegerobligatorioImporte del pedido a pagar.
tax_linesarray de object o nullobligatorioImpuesto de la venta según la clasificación de los productos al momento de la venta: la parte gravable del pedido (ítems salvo ventas de tarjetas de regalo, visitas por encima de lo pagado con un paquete, envío) por alícuota. Para cada alícuota, los tax_lines de los ítems y delivery_tax_lines suman la línea del pedido. El impuesto con valor legal está en el comprobante fiscal: lo define la entidad legal emisora según su condición fiscal. null cuando la tienda no tiene clases impositivas o el pedido no tiene parte gravable.
Campos · 6
regimestringobligatorioQué impuesto: vat — impuesto al valor agregado (IVA); income — ganancias; turnover — Ingresos Brutos; municipal — tasas municipales; internal — impuestos internos; social — seguridad social; other — otro. El impuesto de una venta es vat: la clase impositiva del producto clasifica el IVA.
- Valores:
vatincometurnovermunicipalinternalsocialother
kindstringobligatoriotaxed — a la alícuota; exempt — exento por ley; untaxed — no gravado. Las líneas exempt y untaxed tienen rate_bps 0 y amount 0: el importe está en base.
- Valores:
taxedexemptuntaxed
rate_bpsintegerobligatorioAlícuota en puntos básicos: 2100 es 21 %.
baseintegerobligatorioBase imponible, sin el impuesto. Los precios incluyen impuestos: base + amount es lo que pagó el cliente por esta parte.
amountintegerobligatorioImporte del impuesto. El impuesto de una venta se calcula por alícuota para todo el pedido, la base redondeada a la unidad más cercana y el impuesto como resto; los ítems y el envío reciben partes de él, así sus líneas suman la línea del pedido.
jurisdictionstring o nullobligatorioProvincia o municipio para los impuestos que lo requieren (turnover, municipal); si no, null.
gift_card_issue_amountinteger o nullobligatorioValor de la tarjeta de regalo que vende el pedido: una obligación de la tienda, no un ingreso; null si el pedido no vende una tarjeta.
reservation_deposit_amountinteger o nullobligatorioSeña de una reserva de mesa o de un turno: un pago anticipado, no un ingreso; null si el pedido no es una seña.
account_payment_amountinteger o nullobligatorioPago de la deuda del cliente: dinero a cuenta de la deuda, no un ingreso; null si el pedido no es un pago de deuda.
service_package_issue_amountinteger o nullobligatorioPaquetes de visitas vendidos en el pedido: la tienda debe esas visitas, así que no es un ingreso — el ingreso llega cuando se usa una visita del paquete; null si el pedido no tiene paquetes.
payment_methodstring o nullobligatorioMedio de pago elegido al confirmar el pedido: manual — un medio manual de la tienda (manual_payment_method_id). Los pagos reales están en /v1/payments. null si no se eligió.
- Valores:
cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_packagenull
manual_payment_method_idinteger o nullobligatorioMedio de pago manual de la tienda (/v1/manual-payment-methods) cuando payment_method es manual; si no, null.
delivery_method_idinteger o nullobligatorioMétodo de envío de la tienda (/v1/delivery-methods); null si el pedido no tiene, como una venta en la caja.
fulfilment_typestring o nullobligatorioCómo llega el pedido al cliente, según su método de envío al momento del pedido: self_pickup — retiro en un local; home_delivery — envío a domicilio; parcel_locker — un locker; mail_post — por correo; pos — entrega en la caja; aggregator — envío de una plataforma agregadora; manual_courier — un cadete que la tienda consigue por su cuenta. null si se desconoce.
- Valores:
self_pickuphome_deliveryparcel_lockermail_postposaggregatormanual_couriernull
delivery_slotsarray de objectobligatorioFranjas de entrega elegidas por el cliente, por inicio; vacío si no hay franja.
Campos · 2
fromstringobligatorioInicio de la franja.
tostringobligatorioFin de la franja.
shipmentobject o nullobligatorioEl envío con el transportista, o el número de un servicio de envíos sin integración que cargó la tienda; null si el pedido no tiene. La etiqueta está en GET /v1/orders/{order}/shipment/label cuando label_available es true.
Campos · 8
carrierstringobligatorioEl transportista como clave de módulo: andreani, correo_argentino, uber_direct, mercadolibre (Mercado Envíos); courier_service — un servicio de envíos sin integración cuyo número cargó la tienda (POST /v1/orders/{order}/shipment/tracking), el servicio está en carrier_name, sin estados.
- Valores:
andreanicorreo_argentinouber_directmercadolibrecourier_service
carrier_namestring o nullobligatorioEl servicio tal como lo nombró la tienda, en un número cargado a mano; null con un transportista integrado (lo nombra carrier) o si la tienda no nombró el servicio.
tracking_numberstringobligatorioEl número del envío en el transportista: con él se lo busca en la cuenta del transportista y se lo sigue.
tracking_urlstring o nullobligatorioLa página de seguimiento del transportista; null si no la dio.
statusstring o nullobligatorioEl último estado: accepted — aceptado, el paquete sigue en la tienda; preparing — el transportista prepara el despacho; courier_assigned — un repartidor va a retirarlo; picked_up — retirado; in_transit — en tránsito; arrived_at_branch — espera en una sucursal; out_for_delivery — con el repartidor de última milla; delivery_failed — falló un intento de entrega, el transportista lo reintentará; delivered — entregado; not_delivered — el transportista desistió de entregarlo; returned — devuelto al remitente; lost — perdido; cancelled — cancelado; unknown — un estado del transportista fuera de este conjunto, su texto está en events[].description. null si todavía no hay estado. Un estado intermedio tardío no deshace delivered, cancelled, returned ni lost.
- Valores:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknownnull
status_atstring (date-time) o nullobligatorioCuándo ocurrió el último estado.
eventsarray de objectobligatorioHistorial de estados según el momento del evento en el transportista.
Campos · 3
statusstringobligatorioEl estado — valores como en shipment.status.
- Valores:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknown
descriptionstring o nullobligatorioEl estado en palabras del transportista; null si no dio texto.
occurred_atstring (date-time)obligatorioCuándo ocurrió el evento en el transportista.
label_availablebooleanobligatorioLa etiqueta se puede descargar: la tienda tiene el archivo o el transportista la entrega a pedido.
previous_shipmentsarray de objectobligatorioEnvíos reemplazados por una reemisión (se canceló el anterior y se emitió uno nuevo), del más antiguo al más nuevo; misma forma que shipment, sin label_available.
Campos · 7
carrierstringobligatorioEl transportista — valores como en shipment.carrier.
- Valores:
andreanicorreo_argentinouber_directmercadolibrecourier_service
carrier_namestring o nullobligatorioEl servicio de un número cargado a mano — como en shipment.carrier_name.
tracking_numberstringobligatorioEl número del envío en el transportista.
tracking_urlstring o nullobligatorioLa página de seguimiento del transportista; null si no la dio.
statusstring o nullobligatorioEl último estado — valores como en shipment.status.
- Valores:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknownnull
status_atstring (date-time) o nullobligatorioCuándo ocurrió el último estado.
eventsarray de objectobligatorioHistorial de estados según el momento del evento en el transportista.
Campos · 3
statusstringobligatorioEl estado — valores como en shipment.status.
- Valores:
acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknown
descriptionstring o nullobligatorioEl estado en palabras del transportista; null si no dio texto.
occurred_atstring (date-time)obligatorioCuándo ocurrió el evento en el transportista.
shipment_attemptobject o nullobligatorioUna emisión de envío sin cerrar; null si no hay.
Campos · 3
statestringobligatorioqueued — la emisión se solicitó por la API y espera en la cola; in_progress — la solicitud al transportista está en curso; outcome_unknown — la conexión con el transportista se cortó después de la solicitud y no se sabe si el envío se creó: una nueva emisión queda bloqueada hasta que la tienda lo verifique con el transportista en el panel; failed — la emisión solicitada falló y no hay envío, el motivo está en error.
- Valores:
queuedin_progressoutcome_unknownfailed
started_atstring (date-time)obligatorioCuándo se solicitó o empezó la emisión.
errorobject o nullobligatorioPor qué falló la emisión solicitada; null si no falló.
Campos · 2
codestringobligatorioEl motivo como código: no_carrier — el método de entrega no tiene transportista integrado; not_shippable — el pedido ya no se despacha; awaits_bill_payment — la factura está impaga; carrier_rejected — el transportista la rechazó; shipment_data_invalid — faltan datos del pedido o de la configuración del transportista; request_expired — la solicitud no se procesó a tiempo; internal_error — una falla del servicio antes de contactar al transportista.
- Valores:
no_carriernot_shippableawaits_bill_paymentcarrier_rejectedshipment_data_invalidrequest_expiredinternal_error
messagestringobligatorioEl motivo con las palabras de la tienda en el idioma de la respuesta; si lo rechazó el transportista, con sus palabras.
merged_into_order_idinteger o nullobligatorioEl pedido en el que se fusionó este al unir las cuentas de una mesa: sus ítems y pagos están allí, y este queda como registro vacío cancelado. null si no se fusionó.
cancel_reasonstring o nullobligatorioMotivo de cancelación del sistema: payment_init_failed — el pago no pudo iniciarse; payment_declined — el pago fue rechazado; cashier_void — anulado en la caja; shift_closed — se cerró el turno de la caja; order_timeout — no se pagó a tiempo; merged — fusionado en otro pedido; items_moved — los ítems pasaron a otro pedido; sale_void — la venta se anuló; subscription_day_unserved — un día del plan no se sirvió; booking_forfeit_reverted — se revirtió la retención de una reserva; service_package_term_extended — se extendió un paquete de visitas y se revirtió su vencimiento; membership_renewal_void — se anuló la factura de renovación de una membresía: se canceló o terminó. null si no se canceló o si una persona dio el motivo.
- Valores:
payment_init_failedpayment_declinedcashier_voidshift_closedorder_timeoutmergeditems_movedsale_voidsubscription_day_unservedbooking_forfeit_revertedservice_package_term_extendedmembership_renewal_voidnull
itemsarray de objectobligatorioÍtems del pedido: un registro histórico, los nombres son los del momento de la venta.
Campos · 15
idintegerobligatorioID del ítem.
variant_idinteger o nullobligatorioVariante del ítem; null en un ítem sin variante, como una tarjeta de regalo vendida en la caja.
product_idinteger o nullobligatorioProducto del ítem; null en un ítem sin variante.
product_namemapa de stringobligatorioNombre del producto al momento de la venta, por idioma.
variant_namemapa de stringobligatorioNombre de la variante al momento de la venta, por idioma; un objeto vacío si la variante no tenía nombre.
quantitystringobligatorioCantidad como cadena decimal en unit: unidades en un ítem por unidad, la medida en un ítem por peso o volumen ("480" gramos).
unitstring o nullobligatorioUnidad de quantity: pcs, g o ml; null si la variante ya no conoce la unidad de su medida.
- Valores:
pcsgmlnull
unit_priceinteger o nullobligatorioPrecio de una unidad; null en un ítem por peso o volumen, su importe está en total.
totalintegerobligatorioImporte del ítem.
discountintegerobligatorioDescuento sobre el ítem.
discount_allocationsarray de objectobligatorioDe qué descuentos del registro se compone el descuento del ítem: la suma de amount es igual a items[].discount.
Campos · 2
applied_discount_idintegerobligatorioFila de applied_discounts de este pedido.
amountintegerobligatorioLa parte de este descuento en el ítem.
is_giftbooleanobligatorioRegalo de una promoción o un cupón: el ítem tiene precio y un descuento del 100 %.
tax_linesarray de object o nullobligatorioImpuesto del ítem: su parte del impuesto de su alícuota en tax_lines del pedido. Cubre la parte gravable del ítem: una visita pagada en parte con un paquete cuenta solo el resto. null para un ítem fuera de la venta (venta de una tarjeta de regalo, visita pagada por completo con un paquete, ítem con descuento total) o cuando el impuesto es desconocido.
Campos · 6
regimestringobligatorioQué impuesto: vat — impuesto al valor agregado (IVA); income — ganancias; turnover — Ingresos Brutos; municipal — tasas municipales; internal — impuestos internos; social — seguridad social; other — otro. El impuesto de una venta es vat: la clase impositiva del producto clasifica el IVA.
- Valores:
vatincometurnovermunicipalinternalsocialother
kindstringobligatoriotaxed — a la alícuota; exempt — exento por ley; untaxed — no gravado. Las líneas exempt y untaxed tienen rate_bps 0 y amount 0: el importe está en base.
- Valores:
taxedexemptuntaxed
rate_bpsintegerobligatorioAlícuota en puntos básicos: 2100 es 21 %.
baseintegerobligatorioBase imponible, sin el impuesto. Los precios incluyen impuestos: base + amount es lo que pagó el cliente por esta parte.
amountintegerobligatorioImporte del impuesto. El impuesto de una venta se calcula por alícuota para todo el pedido, la base redondeada a la unidad más cercana y el impuesto como resto; los ítems y el envío reciben partes de él, así sus líneas suman la línea del pedido.
jurisdictionstring o nullobligatorioProvincia o municipio para los impuestos que lo requieren (turnover, municipal); si no, null.
cost_amountinteger o nullCosto del ítem al momento de la venta: un importe en unidades mínimas de currency por el ítem entero, no una tasa. null cuando no se calculó. Solo con el scope costs:read.
cost_basisstring o nullCómo se calculó el costo: variant — el costo de la variante; recipe — la suma de la receta; standard — por la receta estándar, una estimación; partial — solo la parte conocida de la receta, un piso; backfill — estimado después por el costo del catálogo, no al momento de la venta; external — tomado de la caja externa que hizo la venta; unknown — no hay de qué calcularlo. Solo con el scope costs:read.
- Valores:
variantrecipeunknownbackfillstandardpartialexternalnull
customerobject o nullEl cliente del pedido; null en un pedido sin cliente. Solo con el scope customers:read.
Campos · 4
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
namestring o nullobligatorioNombre del cliente; null si se desconoce.
phonestring o nullobligatorioTeléfono principal del cliente en formato E.164, por ejemplo +5491123456789; null si se desconoce.
emailstring o nullobligatorioEmail del cliente; null si se desconoce.
delivery_addressobject o nullDirección de envío al momento del pedido; null en un retiro: el punto de retiro está en location_id. Solo con el scope customers:read.
Campos · 16
kindstringobligatorioaddress — una dirección del cliente; branch — una sucursal de retiro del transportista (branch, address_line).
- Valores:
addressbranch
recipientstring o nullobligatorioQuién recibe el pedido; null si no se indicó.
phonestring o nullobligatorioTeléfono de quien recibe; null si no se indicó.
streetstring o nullobligatorioCalle.
housestring o nullobligatorioNúmero de la calle.
apartmentstring o nullobligatorioDepartamento u oficina.
floorstring o nullobligatorioPiso.
entrancestring o nullobligatorioEntrada.
districtstring o nullobligatorioBarrio.
citystring o nullobligatorioCiudad.
provincestring o nullobligatorioProvincia o estado.
postal_codestring o nullobligatorioCódigo postal.
address_linestring o nullobligatorioDirección de la sucursal del transportista en una línea; null en una dirección del cliente.
commentstring o nullobligatorioComentario del cliente sobre la dirección, como la forma de entrar.
locationobject o nullobligatorioUbicación de la dirección en el mapa; null si se desconoce.
Campos · 2
latnumberobligatorioLatitud en grados.
lngnumberobligatorioLongitud en grados.
branchobject o nullobligatorioLa sucursal del transportista cuando kind es branch; si no, null.
Campos · 2
external_idstring o nullobligatorioID de la sucursal en el sistema del transportista.
namestring o nullobligatorioNombre de la sucursal.
customer_commentstring o nullComentario del cliente al pedido. Solo con el scope customers:read.
fiscal_receptorobject o nullA quién se emite el comprobante fiscal del pedido, fijado en el pedido; null en una venta minorista sin datos fiscales. Solo con el scope customers:read.
Campos · 5
id_typestringobligatorioTipo de identificación: tax_id — CUIT de una empresa; personal_id — CUIL de una persona; national_id — DNI; passport — pasaporte; none — sin identificación.
- Valores:
tax_idpersonal_idnational_idpassportnone
id_numberstring o nullobligatorioNúmero de la identificación; null cuando id_type es none.
namestring o nullobligatorioRazón social o nombre completo para el comprobante; null si no se indicó.
tax_statusstringobligatorioCondición frente al IVA: registered — Responsable Inscripto; small_taxpayer — Monotributo; exempt — exento; final_consumer — consumidor final; not_categorized — no categorizado; foreign — cliente del exterior.
- Valores:
registeredsmall_taxpayerexemptfinal_consumernot_categorizedforeign
addressstring o nullobligatorioDomicilio fiscal en una línea; null si no se indicó.
external_fiscal_documentobject o nullEl comprobante de la venta en una caja externa: el pedido fue a la caja de la tienda o vino de ella, y el comprobante lo emite la caja, no nosotros; ese pedido no tiene comprobantes fiscales. null si no hay comprobante de la caja: el comprobante es nuestro o la caja no lo informó. Solo con el scope fiscal:read.
Campos · 3
issuerstringobligatorioLa caja que emite el comprobante: fudo es FuDo, poster es Poster.
statusstringobligatoriopending: la cuenta está abierta en la caja, que emite el comprobante al cerrarla; issued: la caja emitió el comprobante.
- Valores:
pendingissued
numberstring o nullobligatorioNúmero del comprobante en la caja; null mientras no se emite o si la caja no informa el número.
placed_atstring (date-time)obligatorioCuándo se realizó el pedido.
confirmed_atstring (date-time) o nullobligatorioCuándo la tienda confirmó el pedido; null hasta entonces.
completed_atstring (date-time) o nullobligatorioCuándo se completó el pedido; null hasta entonces.
cancelled_atstring (date-time) o nullobligatorioCuándo se canceló el pedido; null si no se canceló.
refunded_atstring (date-time) o nullobligatorioCuándo se reembolsó el pedido por completo; null si no se reembolsó.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Listar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago
get/orders
Scope: orders:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.
- Largo máximo:
- 4096
updated_sincestring (date-time)Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.
- Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.
numberstringSolo el pedido con este número.
- Largo máximo:
- 16
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.
Campos · 2
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/orders" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Obtener un pedido
get/orders/{order}
Scope: orders:read
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Respuestas
200Éxito
application/json
Devuelve Order
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/orders/{order}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Descargar en PDF la etiqueta del envío actual del pedido; lleva los datos del destinatario, por eso también requiere customers:read
get/orders/{order}/shipment/label
Scope: orders:readcustomers:read
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Respuestas
200Éxito
application/pdf
string (binary)
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
shipment_label_unavailableEl envío no tiene etiqueta - 503
carrier_unavailableEl transportista no responde
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/orders/{order}/shipment/label" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"Pasar un pedido a otro estado de la tienda
post/orders/{order}/status
Scope: orders:write
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
statusstringobligatorioEstado del pedido: un código de la lista de estados de la tienda (/v1/order-statuses). La tienda puede agregar sus propios estados; status_group da el significado permanente.
- Largo máximo:
- 50
commentstring o nullComentario del cambio, queda en el historial del pedido.
- Largo máximo:
- 500
delivery_failure_reasonstring o nullAl pasar a un estado del grupo delivery_failed — por qué: customer_absent — no había nadie en la dirección; refused — el cliente rechazó el pedido; wrong_address — no se encontró la dirección; no_contact — no se pudo contactar al cliente; other — otro motivo, explicado en comment.
- Valores:
customer_absentrefusedwrong_addressno_contactothernull
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve Order
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
order_transition_refusedEl pedido no puede pasar a este estado - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/orders/{order}/status" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"status": "string",
"comment": "string",
"delivery_failure_reason": "customer_absent"
}{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Cancelar un pedido
post/orders/{order}/cancel
Scope: orders:write
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Query
consentobjectConsentimientos a las consecuencias del cambio, por tipo: consent[<consent_kind>]=<consent_token> de una respuesta 409 consent_required. Conservá los consentimientos ya dados cuando se pide el tipo siguiente.
Campos · 1
order_cancelstringCancelar el pedido devuelve el dinero recibido al cliente, a la suscripción o a la reserva, emite una nota de crédito por el comprobante fiscal, cancela el envío del transportista y deja como pérdida la mercadería ya preparada.
- Largo mínimo:
- 64
- Largo máximo:
- 64
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
statusstringEstado del pedido: un código de la lista de estados de la tienda (/v1/order-statuses). La tienda puede agregar sus propios estados; status_group da el significado permanente.
- Largo máximo:
- 50
commentstring o nullMotivo de la cancelación en palabras, queda en el historial del pedido.
- Largo máximo:
- 500
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve Order
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
consent_requiredHace falta consentir las consecuencias - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
order_cancel_refusedEl pedido no se puede cancelar - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/orders/{order}/cancel" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"status": "string",
"comment": "string"
}{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Emitir el envío del pedido con su transportista: la solicitud se procesa en segundo plano y el resultado aparece en el pedido y llega con order.updated
post/orders/{order}/shipment
Scope: orders:write
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve Order
202Aceptado: el resultado está en la dirección de Location
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
Locationstring (uri)obligatorioDirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.
application/json
Devuelve Order
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
shipment_in_progressYa hay una emisión de envío en curso - 409
shipment_outcome_unknownEl resultado de la emisión anterior es desconocido - 409
shipment_refusedNo se puede emitir el envío ahora - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Cargar el número de seguimiento de un servicio de envíos sin integración: número, enlace y nombre del servicio
post/orders/{order}/shipment/tracking
Scope: orders:write
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
tracking_numberstringobligatorioEl número en el servicio de envíos: letras y dígitos, con espacios, puntos, barras, guiones y guiones bajos adentro; hasta 64 caracteres.
- Largo máximo:
- 64
- Patrón:
^[\p{L}\p{N}](?:[\p{L}\p{N} .\/_-]*[\p{L}\p{N}])?$
tracking_urlstring (uri) o nullLa página de seguimiento del servicio, http o https; null o sin el campo — sin enlace.
- Largo máximo:
- 500
carrier_namestring o nullEl nombre del servicio como lo verá el cliente: «Correo Argentino», «OCA»; null o sin el campo — sin nombre.
- Largo máximo:
- 100
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve Order
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
shipment_in_progressYa hay una emisión de envío en curso - 409
shipment_tracking_refusedNo se puede cargar el número de seguimiento a mano - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment/tracking" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"tracking_number": "string",
"tracking_url": "string",
"carrier_name": "string"
}{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Quitar un número de seguimiento cargado a mano
post/orders/{order}/shipment/tracking/clear
Scope: orders:write
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve Order
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
shipment_in_progressYa hay una emisión de envío en curso - 409
shipment_tracking_refusedNo se puede cargar el número de seguimiento a mano - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment/tracking/clear" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"channel": "web",
"app_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"status": "string",
"status_group": "pos_open",
"payment_status": "unpaid",
"sale_type": "retail",
"currency": "string",
"items_total": 0,
"discount": 0,
"applied_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"reason": "string",
"order_item_id": 0,
"amount": 0
}
],
"delivery_cost": 0,
"delivery_discount": 0,
"delivery_discounts": [
{
"id": 0,
"source": "promocode",
"kind": "promo",
"name": {},
"code": "string",
"amount": 0
}
],
"delivery_tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"platform_discount": 0,
"platform_service_fee": 0,
"platform_delivery_fee": 0,
"total": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"gift_card_issue_amount": 0,
"reservation_deposit_amount": 0,
"account_payment_amount": 0,
"service_package_issue_amount": 0,
"payment_method": "cash",
"manual_payment_method_id": 0,
"delivery_method_id": 0,
"fulfilment_type": "self_pickup",
"delivery_slots": [
{
"from": "string",
"to": "string"
}
],
"shipment": {
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
],
"label_available": true
},
"previous_shipments": [
{
"carrier": "andreani",
"carrier_name": "string",
"tracking_number": "string",
"tracking_url": "string",
"status": "accepted",
"status_at": "2026-01-15T12:00:00Z",
"events": [
{
"status": "accepted",
"description": "string",
"occurred_at": "2026-01-15T12:00:00Z"
}
]
}
],
"shipment_attempt": {
"state": "queued",
"started_at": "2026-01-15T12:00:00Z",
"error": {
"code": "no_carrier",
"message": "string"
}
},
"merged_into_order_id": 0,
"cancel_reason": "payment_init_failed",
"items": [
{
"id": 0,
"variant_id": 0,
"product_id": 0,
"product_name": {
"key": "string"
},
"variant_name": {
"key": "string"
},
"quantity": "string",
"unit": "pcs",
"unit_price": 0,
"total": 0,
"discount": 0,
"discount_allocations": [
{
"applied_discount_id": 0,
"amount": 0
}
],
"is_gift": true,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"cost_amount": 0,
"cost_basis": "variant"
}
],
"customer": {
"id": 0,
"name": "string",
"phone": "string",
"email": "string"
},
"delivery_address": {
"kind": "address",
"recipient": "string",
"phone": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"address_line": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"branch": {
"external_id": "string",
"name": "string"
}
},
"customer_comment": "string",
"fiscal_receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
},
"external_fiscal_document": {
"issuer": "string",
"status": "pending",
"number": "string"
},
"placed_at": "2026-01-15T12:00:00Z",
"confirmed_at": "2026-01-15T12:00:00Z",
"completed_at": "2026-01-15T12:00:00Z",
"cancelled_at": "2026-01-15T12:00:00Z",
"refunded_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}