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.

Cargando el índice de búsqueda…

Pedidos

Objetos

Order

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • numberstring o nullobligatorio

    Número del pedido que ven el cliente y el personal; null mientras el pedido aún no lo tiene.

  • channelstringobligatorio

    De 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 nullobligatorio

    La 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_idintegerobligatorio

    Local que atiende el pedido: el punto de retiro o el local del que se descuenta el stock.

  • legal_entity_idinteger o nullobligatorio

    Razó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.

  • statusstringobligatorio

    Estado 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_groupstringobligatorio

    Significado 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_statusstringobligatorio

    Pago del pedido: unpaid — sin pagar; partial — pagado en parte; paid — pagado; partially_refunded — reembolsado en parte; refunded — reembolsado.

    Valores:
    unpaidpartialpaidpartially_refundedrefunded
  • sale_typestringobligatorio

    retail — venta a un cliente; staff — venta a un empleado; wholesale — venta mayorista.

    Valores:
    retailstaffwholesale
  • currencystringobligatorio

    Moneda de los importes, código ISO 4217: la moneda de la tienda.

  • items_totalintegerobligatorio

    Suma de los ítems antes del descuento del pedido.

  • discountintegerobligatorio

    Descuento del pedido sobre los productos: la suma de applied_discounts[].amount y de items[].discount.

  • applied_discountsarray de objectobligatorio

    De 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
    • idintegerobligatorio

      Fila del registro; items[].discount_allocations[].applied_discount_id apunta a ella.

    • sourcestringobligatorio

      Có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 nullobligatorio

      Por 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 nullobligatorio

      Nombre 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 nullobligatorio

      El código promocional que ingresó el comprador; null — no es un descuento por código.

    • reasonstring o nullobligatorio

      El motivo del descuento manual en palabras del cajero; null en los demás.

    • order_item_idinteger o nullobligatorio

      El ítem rebajado por separado; null — un descuento sobre el pedido, sus partes por ítem están en items[].discount_allocations.

    • amountintegerobligatorio

      Importe del descuento.

  • delivery_costintegerobligatorio

    Envío a pagar, después del descuento sobre el envío.

  • delivery_discountintegerobligatorio

    Descontado del envío: el precio del envío antes del descuento es delivery_cost + delivery_discount.

  • delivery_discountsarray de objectobligatorio

    De qué se compone el descuento sobre el envío: la suma de amount es igual a delivery_discount.

    Campos · 6
    • idintegerobligatorio

      Fila del registro de descuentos del envío.

    • sourcestringobligatorio

      Cómo llegó el descuento al pedido: los valores de applied_discounts[].source.

      Valores:
      promocodeautomaticpickmanualoffline_captureloyalty_programexternal_pos
    • kindstring o nullobligatorio

      Por qué es el descuento: los valores de applied_discounts[].kind.

      Valores:
      promoemployeeexpirypayment_methodmarkdowngoodwillcompothernull
    • nameobject o nullobligatorio

      Nombre de la regla al momento de la venta; null — un descuento por código promocional.

    • codestring o nullobligatorio

      El código promocional que ingresó el comprador; null — no es un descuento por código.

    • amountintegerobligatorio

      Importe del descuento sobre el envío.

  • delivery_tax_linesarray de object o nullobligatorio

    Impuesto 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
    • regimestringobligatorio

      Qué 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
    • kindstringobligatorio

      taxed — 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_bpsintegerobligatorio

      Alícuota en puntos básicos: 2100 es 21 %.

    • baseintegerobligatorio

      Base imponible, sin el impuesto. Los precios incluyen impuestos: base + amount es lo que pagó el cliente por esta parte.

    • amountintegerobligatorio

      Importe 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 nullobligatorio

      Provincia o municipio para los impuestos que lo requieren (turnover, municipal); si no, null.

  • platform_discountintegerobligatorio

    Descuento que paga la plataforma agregadora: no reduce la venta de la tienda.

  • platform_service_feeintegerobligatorio

    Tarifa de servicio de la plataforma agregadora: forma parte de total, pero no es venta de la tienda.

  • platform_delivery_feeintegerobligatorio

    Envío que hace la plataforma agregadora: forma parte de total, pero no es venta de la tienda.

  • totalintegerobligatorio

    Importe del pedido a pagar.

  • tax_linesarray de object o nullobligatorio

    Impuesto 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
    • regimestringobligatorio

      Qué 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
    • kindstringobligatorio

      taxed — 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_bpsintegerobligatorio

      Alícuota en puntos básicos: 2100 es 21 %.

    • baseintegerobligatorio

      Base imponible, sin el impuesto. Los precios incluyen impuestos: base + amount es lo que pagó el cliente por esta parte.

    • amountintegerobligatorio

      Importe 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 nullobligatorio

      Provincia o municipio para los impuestos que lo requieren (turnover, municipal); si no, null.

  • gift_card_issue_amountinteger o nullobligatorio

    Valor 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 nullobligatorio

    Señ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 nullobligatorio

    Pago 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 nullobligatorio

    Paquetes 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 nullobligatorio

    Medio 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 nullobligatorio

    Medio de pago manual de la tienda (/v1/manual-payment-methods) cuando payment_method es manual; si no, null.

  • delivery_method_idinteger o nullobligatorio

    Mé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 nullobligatorio

    Có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 objectobligatorio

    Franjas de entrega elegidas por el cliente, por inicio; vacío si no hay franja.

    Campos · 2
    • fromstringobligatorio

      Inicio de la franja.

    • tostringobligatorio

      Fin de la franja.

  • shipmentobject o nullobligatorio

    El 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
    • carrierstringobligatorio

      El 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 nullobligatorio

      El 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_numberstringobligatorio

      El 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 nullobligatorio

      La página de seguimiento del transportista; null si no la dio.

    • statusstring o nullobligatorio

      El ú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 nullobligatorio

      Cuándo ocurrió el último estado.

    • eventsarray de objectobligatorio

      Historial de estados según el momento del evento en el transportista.

      Campos · 3
      • statusstringobligatorio

        El estado — valores como en shipment.status.

        Valores:
        acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknown
      • descriptionstring o nullobligatorio

        El estado en palabras del transportista; null si no dio texto.

      • occurred_atstring (date-time)obligatorio

        Cuándo ocurrió el evento en el transportista.

    • label_availablebooleanobligatorio

      La etiqueta se puede descargar: la tienda tiene el archivo o el transportista la entrega a pedido.

  • previous_shipmentsarray de objectobligatorio

    Enví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
    • carrierstringobligatorio

      El transportista — valores como en shipment.carrier.

      Valores:
      andreanicorreo_argentinouber_directmercadolibrecourier_service
    • carrier_namestring o nullobligatorio

      El servicio de un número cargado a mano — como en shipment.carrier_name.

    • tracking_numberstringobligatorio

      El número del envío en el transportista.

    • tracking_urlstring o nullobligatorio

      La página de seguimiento del transportista; null si no la dio.

    • statusstring o nullobligatorio

      El último estado — valores como en shipment.status.

      Valores:
      acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknownnull
    • status_atstring (date-time) o nullobligatorio

      Cuándo ocurrió el último estado.

    • eventsarray de objectobligatorio

      Historial de estados según el momento del evento en el transportista.

      Campos · 3
      • statusstringobligatorio

        El estado — valores como en shipment.status.

        Valores:
        acceptedpreparingcourier_assignedpicked_upin_transitarrived_at_branchout_for_deliverydelivery_faileddeliverednot_deliveredreturnedlostcancelledunknown
      • descriptionstring o nullobligatorio

        El estado en palabras del transportista; null si no dio texto.

      • occurred_atstring (date-time)obligatorio

        Cuándo ocurrió el evento en el transportista.

  • shipment_attemptobject o nullobligatorio

    Una emisión de envío sin cerrar; null si no hay.

    Campos · 3
    • statestringobligatorio

      queued — 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)obligatorio

      Cuándo se solicitó o empezó la emisión.

    • errorobject o nullobligatorio

      Por qué falló la emisión solicitada; null si no falló.

      Campos · 2
      • codestringobligatorio

        El 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
      • messagestringobligatorio

        El 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 nullobligatorio

    El 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 nullobligatorio

    Motivo 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
    • idintegerobligatorio

      ID del ítem.

    • variant_idinteger o nullobligatorio

      Variante del ítem; null en un ítem sin variante, como una tarjeta de regalo vendida en la caja.

    • product_idinteger o nullobligatorio

      Producto del ítem; null en un ítem sin variante.

    • product_namemapa de stringobligatorio

      Nombre del producto al momento de la venta, por idioma.

    • variant_namemapa de stringobligatorio

      Nombre de la variante al momento de la venta, por idioma; un objeto vacío si la variante no tenía nombre.

    • quantitystringobligatorio

      Cantidad como cadena decimal en unit: unidades en un ítem por unidad, la medida en un ítem por peso o volumen ("480" gramos).

    • unitstring o nullobligatorio

      Unidad de quantity: pcs, g o ml; null si la variante ya no conoce la unidad de su medida.

      Valores:
      pcsgmlnull
    • unit_priceinteger o nullobligatorio

      Precio de una unidad; null en un ítem por peso o volumen, su importe está en total.

    • totalintegerobligatorio

      Importe del ítem.

    • discountintegerobligatorio

      Descuento sobre el ítem.

    • discount_allocationsarray de objectobligatorio

      De qué descuentos del registro se compone el descuento del ítem: la suma de amount es igual a items[].discount.

      Campos · 2
      • applied_discount_idintegerobligatorio

        Fila de applied_discounts de este pedido.

      • amountintegerobligatorio

        La parte de este descuento en el ítem.

    • is_giftbooleanobligatorio

      Regalo de una promoción o un cupón: el ítem tiene precio y un descuento del 100 %.

    • tax_linesarray de object o nullobligatorio

      Impuesto 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
      • regimestringobligatorio

        Qué 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
      • kindstringobligatorio

        taxed — 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_bpsintegerobligatorio

        Alícuota en puntos básicos: 2100 es 21 %.

      • baseintegerobligatorio

        Base imponible, sin el impuesto. Los precios incluyen impuestos: base + amount es lo que pagó el cliente por esta parte.

      • amountintegerobligatorio

        Importe 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 nullobligatorio

        Provincia o municipio para los impuestos que lo requieren (turnover, municipal); si no, null.

    • cost_amountinteger o null

      Costo 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 null

      Có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 null

    El cliente del pedido; null en un pedido sin cliente. Solo con el scope customers:read.

    Campos · 4
    • idintegerobligatorio

      ID del registro, único entre los registros de su tipo en la tienda.

    • namestring o nullobligatorio

      Nombre del cliente; null si se desconoce.

    • phonestring o nullobligatorio

      Teléfono principal del cliente en formato E.164, por ejemplo +5491123456789; null si se desconoce.

    • emailstring o nullobligatorio

      Email del cliente; null si se desconoce.

  • delivery_addressobject o null

    Direcció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
    • kindstringobligatorio

      address — una dirección del cliente; branch — una sucursal de retiro del transportista (branch, address_line).

      Valores:
      addressbranch
    • recipientstring o nullobligatorio

      Quién recibe el pedido; null si no se indicó.

    • phonestring o nullobligatorio

      Teléfono de quien recibe; null si no se indicó.

    • streetstring o nullobligatorio

      Calle.

    • housestring o nullobligatorio

      Número de la calle.

    • apartmentstring o nullobligatorio

      Departamento u oficina.

    • floorstring o nullobligatorio

      Piso.

    • entrancestring o nullobligatorio

      Entrada.

    • districtstring o nullobligatorio

      Barrio.

    • citystring o nullobligatorio

      Ciudad.

    • provincestring o nullobligatorio

      Provincia o estado.

    • postal_codestring o nullobligatorio

      Código postal.

    • address_linestring o nullobligatorio

      Dirección de la sucursal del transportista en una línea; null en una dirección del cliente.

    • commentstring o nullobligatorio

      Comentario del cliente sobre la dirección, como la forma de entrar.

    • locationobject o nullobligatorio

      Ubicación de la dirección en el mapa; null si se desconoce.

      Campos · 2
      • latnumberobligatorio

        Latitud en grados.

      • lngnumberobligatorio

        Longitud en grados.

    • branchobject o nullobligatorio

      La sucursal del transportista cuando kind es branch; si no, null.

      Campos · 2
      • external_idstring o nullobligatorio

        ID de la sucursal en el sistema del transportista.

      • namestring o nullobligatorio

        Nombre de la sucursal.

  • customer_commentstring o null

    Comentario del cliente al pedido. Solo con el scope customers:read.

  • fiscal_receptorobject o null

    A 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_typestringobligatorio

      Tipo 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 nullobligatorio

      Número de la identificación; null cuando id_type es none.

    • namestring o nullobligatorio

      Razón social o nombre completo para el comprobante; null si no se indicó.

    • tax_statusstringobligatorio

      Condició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 nullobligatorio

      Domicilio fiscal en una línea; null si no se indicó.

  • external_fiscal_documentobject o null

    El 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
    • issuerstringobligatorio

      La caja que emite el comprobante: fudo es FuDo, poster es Poster.

    • statusstringobligatorio

      pending: la cuenta está abierta en la caja, que emite el comprobante al cerrarla; issued: la caja emitió el comprobante.

      Valores:
      pendingissued
    • numberstring o nullobligatorio

      Número del comprobante en la caja; null mientras no se emite o si la caja no informa el número.

  • placed_atstring (date-time)obligatorio

    Cuándo se realizó el pedido.

  • confirmed_atstring (date-time) o nullobligatorio

    Cuándo la tienda confirmó el pedido; null hasta entonces.

  • completed_atstring (date-time) o nullobligatorio

    Cuándo se completó el pedido; null hasta entonces.

  • cancelled_atstring (date-time) o nullobligatorio

    Cuándo se canceló el pedido; null si no se canceló.

  • refunded_atstring (date-time) o nullobligatorio

    Cuándo se reembolsó el pedido por completo; null si no se reembolsó.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

  • updated_atstring (date-time)obligatorio

    Cuá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

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor 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_deletedboolean

    true — 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.

  • numberstring

    Solo el pedido con este número.

    Largo máximo:
    16

Respuestas

200Éxito

application/json

  • dataarray de Orderobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros 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
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En 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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl "https://api.saleya.app/v1/orders" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "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

  • orderintegerobligatorio

    ID del pedido.

Respuestas

200Éxito

application/json

Devuelve Order

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl "https://api.saleya.app/v1/orders/{order}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "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

  • orderintegerobligatorio

    ID del pedido.

Respuestas

200Éxito

application/pdf

string (binary)

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterinteger

    Segundos 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
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

  • orderintegerobligatorio

    ID del pedido.

Encabezado

  • Idempotency-Keystring

    Clave ú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

  • statusstringobligatorio

    Estado 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 null

    Comentario del cambio, queda en el historial del pedido.

    Largo máximo:
    500
  • delivery_failure_reasonstring o null

    Al 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-Replayedstring

    true 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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterinteger

    Segundos 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
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
Cuerpo de la solicitud — body.json
{
  "status": "string",
  "comment": "string",
  "delivery_failure_reason": "customer_absent"
}
Ejemplo de respuesta · 200
{
  "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

  • orderintegerobligatorio

    ID del pedido.

Query

  • consentobject

    Consentimientos 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_cancelstring

      Cancelar 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-Keystring

    Clave ú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

  • statusstring

    Estado 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 null

    Motivo de la cancelación en palabras, queda en el historial del pedido.

    Largo máximo:
    500

Respuestas

200Éxito

Encabezados

  • Idempotent-Replayedstring

    true 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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterinteger

    Segundos 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
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
Cuerpo de la solicitud — body.json
{
  "status": "string",
  "comment": "string"
}
Ejemplo de respuesta · 200
{
  "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

  • orderintegerobligatorio

    ID del pedido.

Encabezado

  • Idempotency-Keystring

    Clave ú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-Replayedstring

    true 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-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true
  • Locationstring (uri)obligatorio

    Direcció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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterinteger

    Segundos 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "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

  • orderintegerobligatorio

    ID del pedido.

Encabezado

  • Idempotency-Keystring

    Clave ú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_numberstringobligatorio

    El 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 null

    La página de seguimiento del servicio, http o https; null o sin el campo — sin enlace.

    Largo máximo:
    500
  • carrier_namestring o null

    El 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-Replayedstring

    true 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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterinteger

    Segundos 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
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
Cuerpo de la solicitud — body.json
{
  "tracking_number": "string",
  "tracking_url": "string",
  "carrier_name": "string"
}
Ejemplo de respuesta · 200
{
  "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

  • orderintegerobligatorio

    ID del pedido.

Encabezado

  • Idempotency-Keystring

    Clave ú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-Replayedstring

    true 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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterinteger

    Segundos 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl -X POST "https://api.saleya.app/v1/orders/{order}/shipment/tracking/clear" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "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"
}