Representa a una orden o pedido de un cliente.
Los pedidos finalizados son archivados al final del día (12am) del horario local. El valor
deleted_at es actualizado con la fecha de archivado.
subtotal_original_e2: Monto total de productos de la orden (sin aplicar descuentos todavía).subtotal_e2: Monto total de productos tras aplicar descuentos de precio base al subtotal_original_e2.tax_e2: Monto de la orden adicional a los productos ordenados, por ejemplo, delivery, servicio o descuentos.total_e2: Monto final de la orden. Equivale a subtotal_e2 + tax_e2branch_subtotal_e2: Monto final de vista al comercio. Equivale a subtotal_original_e2 - branch_discounts_e2 donde
branch_discounts_e2 representa al monto total de descuentos asumidos por el comercio.En general, la orden se calcula en el siguiente orden:
subtotal_original_e2.subtotal_original_e2 se le aplican los descuentos de base_price y obtenemos subtotal_e2subtotal_e2 se calculan los descuentos de subtotal y se registra en la lista de taxes.subtotal_e2 después de descuentos, se le calcula el service_fee_e2 (Servicio App) y se registra en la lista de taxes.taxes.taxes.taxes.taxes.taxes.tax_e2.total_e2 sumando subtotal_e2 + tax_e2.payment_fee_e2 y se cobra total_e2 + payment_fee_e2.
(esto no afecta los montos de la orden).number: Representa el número de órden relativo (al Comercio o Company).uid: Número de identificación de la orden en la Company.notes: Notas de entregascheduled_at: Fecha de entrega solicitada por el cliente para órdenes programadas.paid_at: Fecha de pago.being_prepared_at: Fecha de inicio de preparación por el comercio o shopper.prepared_at: Fecha de fin de preparación por el comercio o shopper.collected_at: Fecha de recolección del repartidor para iniciar la entrega hacia el cliente.arrived_at: Fecha de llegada del repartidor al sitio de entrega.completed_at: Fecha de finalización de la orden (de entrega o cancelación).receiver_name: Nombre de quien recibe.receiver_phone: Teléfono de quien recibe.is_gift: Indica si recibe otra persona (alguien distinto a quien crea la orden)source: Origen de la orden. null para órdenes nativas. Ejemplo: Ridery para órdenes creadas desde el WebView en Ridery.device: Información del dispositivo desde el cual se creó la orden.selected_payment_method: Información de pago cuando se elige pagar al momento de la entrega (POS, Efectivo, etc.).latest_status: Última acción que generó un cambio de estado.status_for_clients: Status para mostrar al Cliente.status_for_shoppers: Status para mostrar al Shopper. N/A si no aplica.status_for_providers: Status para mostrar al Repartidor o Proveedor. N/A si no aplica.status_for_company_admins: Status para mostrar a Administradores de Company.status_for_branch_admins: Status para mostrar a Administradores de Comercio.status_for_payment: Status de pago.order_provider_snapshot: Repartidor asignado.estimated_route: Ruta estimada y tiempo estimado de entrega.partner_name: Nombre de asociado que atenderá la orden.partner: Información del asociado asignado a la orden.partner_validation_url: URL de verificación (QR) para autorizar la preparación de una orden.partner_pod_pin: Código de entrega entre shopper y repartidor.service_charge: Información de la flota asociada a la orden para realizar la entrega.ordered_goods: Lista de productos.administrator_notes: Notas de administrador en caso de incidencias.probable_eta: Tiempo estimado de entrega de la orden calculada por el sistema.locations: Coordenadas (para Entregas de tipo punto A punto B)payment_types: Tipos de pago realizados.taxes: Descripción detallada de los tax aplicados a la orden (delivery, descuentos, etc).| Atributo | Tipo | Descripción |
|---|---|---|
id |
int |
|
number |
int\|null |
|
status |
int |
|
subtotal_e2 |
int |
|
total_e2 |
int |
|
tax_e2 |
int |
|
notes |
string\|null |
|
scheduled_at |
datetime\|null |
|
client_latitude_e6 |
int |
|
client_longitude_e6 |
int |
|
client_address_data |
array\|null |
|
pickup_latitude_e6 |
int |
|
pickup_longitude_e6 |
int |
|
pickup_address |
string\|null |
|
completed_at |
datetime\|null |
|
deleted_at |
datetime\|null |
|
created_at |
datetime\|null |
|
updated_at |
datetime\|null |
|
company_id |
int |
|
client_id |
int\|null |
|
creator_id |
int\|null |
|
branch_id |
int\|null |
|
uid |
string\|null |
|
receiver_name |
string\|null |
|
receiver_phone |
string\|null |
|
is_gift |
bool\|null |
|
shopper_id |
int\|null |
|
currency_iso |
string\|null |
|
branch_group_id |
int\|null |
|
subtotal_original_e2 |
int\|null |
|
branch_rating_id |
int\|null |
|
paid_at |
datetime\|null |
|
being_prepared_at |
datetime\|null |
|
prepared_at |
datetime\|null |
|
collected_at |
datetime\|null |
|
arrived_at |
datetime\|null |
|
preparation_time |
int\|null |
|
total_preparation_time |
int\|null |
|
collection_time |
int\|null |
|
arrival_time |
int\|null |
|
fleet_association_id |
int\|null |
|
source |
string\|null |
|
city_id |
int\|null |
|
client_address |
string\|null |
|
locations |
array\|null |
|
order_edit_data |
OrderEditData\|null |
|
ordered_goods |
array\|null |
|
is_service |
bool |
BitMask (({@link self::status} & 0x1) !== 0) |
is_pickup_enabled |
bool |
BitMask (({@link self::status} & 0x2) !== 0) |
is_type_digital |
bool |
BitMask (({@link self::status} & 0x4) !== 0) |
is_delivery |
bool |
BitMask (({@link self::status} & 0x8) !== 0) |
is_bid_waiting_client |
bool |
BitMask (({@link self::status} & 0x10) !== 0) |
is_bid_waiting_admin |
bool |
BitMask (({@link self::status} & 0x20) !== 0) |
is_bid_waiting_provider |
bool |
BitMask (({@link self::status} & 0x40) !== 0) |
is_asap |
bool |
BitMask (({@link self::status} & 0x80) !== 0) |
is_status_unconfirmed |
bool |
BitMask (({@link self::status} & 0x100) !== 0) |
is_payment_waiting_confirmation |
bool |
BitMask (({@link self::status} & 0x200) !== 0) |
is_payment_confirmed |
bool |
BitMask (({@link self::status} & 0x400) !== 0) |
is_provider_assigned |
bool |
BitMask (({@link self::status} & 0x800) !== 0) |
is_provider_started |
bool |
BitMask (({@link self::status} & 0x1000) !== 0) |
is_status_arrived |
bool |
BitMask (({@link self::status} & 0x2000) !== 0) |
is_provider_working |
bool |
BitMask (({@link self::status} & 0x4000) !== 0) |
is_status_completed |
bool |
BitMask (({@link self::status} & 0x8000) !== 0) |
is_status_canceled |
bool |
BitMask (({@link self::status} & 0x10000) !== 0) |
is_status_completed_ok |
bool |
BitMask (({@link self::status} & 0x20000) !== 0) |
is_refund_applied |
bool |
BitMask (({@link self::status} & 0x40000) !== 0) |
is_refund_pending |
bool |
BitMask (({@link self::status} & 0x80000) !== 0) |
is_payment_later |
bool |
BitMask (({@link self::status} & 0x100000) !== 0) |
is_status_being_prepared |
bool |
BitMask (({@link self::status} & 0x200000) !== 0) |
is_status_prepared |
bool |
BitMask (({@link self::status} & 0x400000) !== 0) |
is_provider_arrived |
bool |
BitMask (({@link self::status} & 0x800000) !== 0) |
is_provider_collected |
bool |
BitMask (({@link self::status} & 0x1000000) !== 0) |
is_status_expired |
bool |
BitMask (({@link self::status} & 0x2000000) !== 0) |
is_shopper_allowed |
bool |
BitMask (({@link self::status} & 0x4000000) !== 0) |
is_shopper_assigned |
bool |
BitMask (({@link self::status} & 0x8000000) !== 0) |
is_pool_private |
bool |
BitMask (({@link self::status} & 0x10000000) !== 0) |
is_invoice_allowed |
bool |
BitMask (({@link self::status} & 0x20000000) !== 0) |
is_for_shipping |
bool |
BitMask (({@link self::status} & 0x40000000) !== 0) |
has_item_updates |
bool |
BitMask (({@link self::status} & 0x80000000) !== 0) |
is_sent_to_pool |
bool |
BitMask (({@link self::status} & 0x100000000) !== 0) |
is_trip |
bool |
BitMask (({@link self::status} & 0x200000000) !== 0) |
is_trip_locked |
bool |
BitMask (({@link self::status} & 0x400000000) !== 0) |
is_bot_attempting |
bool |
BitMask (({@link self::status} & 0x800000000) !== 0) |
is_no_provider_dispatch |
bool |
BitMask (({@link self::status} & 0x1000000000) !== 0) |
is_dispatched_without_provider |
bool |
BitMask (({@link self::status} & 0x2000000000) !== 0) |
is_payment_later_required |
bool |
BitMask (({@link self::status} & 0x4000000000) !== 0) |
is_type_good |
bool |
BitMask (({@link self::status} & 0x1) === 0) |
is_scheduled |
bool |
BitMask (({@link self::status} & 0x80) === 0) |
is_status_confirmed |
bool |
BitMask (({@link self::status} & 0x100) === 0) |
is_no_bid_waiting |
bool |
BitMask ((({@link self::status} & 0x70) >> 4) === 0) |
additional_delivery_fee_e2 |
int |
|
admin_url |
string |
|
administrator_notes |
Collection |
|
allLogs |
ApiLog> |
|
allOrderedGoodItems |
OrderedGood> |
|
allPayments |
Payment> |
|
amount_for_debugging |
Money\|null |
|
applied_taxes |
array |
|
assignedOrderProviders |
OrderProvider> |
|
assigning_bot_status |
string\|null |
|
balance |
OrderBalance |
|
base_delivery_fee_e2 |
int |
|
base_price_e2 |
int |
|
bids |
Bid> |
|
bids_snapshot |
array |
|
branch |
Branch\|null |
|
branch_group |
BranchGroup\|null |
|
branchPendingFee |
BranchPendingFee\|null |
|
branchRating |
BranchRating\|null |
|
branch_subtotal_e2 |
int |
|
cancellationReason |
OrderCancellationReason\|null |
|
cashback_e2 |
int |
|
cashbacks |
CouponUsage> |
|
charges_e2 |
int |
|
client |
Client\|null |
|
client_debt_e2 |
int |
|
client_payment_e2 |
int |
|
clientRating |
ClientRating\|null |
|
client_rating_e2 |
int |
|
clientRatings |
ClientRating> |
|
company |
Company |
|
companyActiveOrder |
CompanyActiveOrder\|null |
|
company_currency_snapshot |
Currency\|null |
|
creator |
Admin\|null |
|
currency_rates |
array |
|
currency_snapshot |
Currency\|null |
|
current_delay_in_seconds |
int |
|
delivery_eta_in_seconds |
int |
|
delivery_fee_e2 |
int |
|
delivery_fee_e2_paid_for_client |
int |
|
delivery_fee_to_pay_e2 |
int |
|
delivery_notes |
string |
|
desired_pickup_at |
datetime\|null |
|
destination_city |
City\|null |
|
device |
array\|null |
|
discount_e2 |
int |
|
discounts |
CouponUsage> |
|
discountsAndCashbacks |
CouponUsage> |
|
driver_assigning_delay_in_seconds |
int |
|
effective_discount_e2 |
int |
|
effective_service_fee_e2 |
int |
|
estimated_max_weight |
int |
|
estimated_route |
DirectionsEstimated\|null |
|
estimated_route_for_assigned_provider |
DirectionsEstimated\|null |
|
external_id |
string\|null |
|
external_source |
string\|null |
|
fleet |
Fleet\|null |
|
fleet_association |
FleetAssociation\|null |
|
fleet_association_shipment_action |
string\|null |
|
full_delivery_eta_in_seconds |
int |
|
full_preparation_eta_in_seconds |
int |
|
generalInvoiceItems |
GeneralInvoiceItem> |
|
gmv_e2 |
int |
|
goodRatings |
GoodRating> |
|
goods |
Good> |
|
google_maps_url |
string\|null |
|
gross_total_e2 |
int |
|
histories |
OrderHistory> |
|
initial_eta |
datetime |
|
invoiceDocumentItems |
InvoiceDocumentItem> |
|
is_arriving_for_pickup |
bool |
|
is_expiration_allowed |
bool |
|
is_multi_provider_allowed |
bool |
|
is_provider_chat_allowed |
bool |
|
is_provider_dial_allowed |
bool |
|
items_quantity |
int |
|
last_status_change |
int |
|
latest_status |
string |
|
local_date |
datetime |
|
logs |
ApiLog> |
|
notifications |
Notification> |
|
order_location_history |
Collection |
|
orderProviderServices |
OrderProviderService> |
|
order_provider_snapshot |
OrderProvider\|null |
|
orderProviders |
OrderProvider> |
|
orderedGoodItems |
OrderedGood> |
|
orderedGoodItemsWithPromo |
OrderedGood> |
|
ordered_goods_converted |
Collection |
|
ordered_goods_history |
Collection |
|
package_content |
string\|null |
|
package_description |
string |
|
package_info |
PackageInfo\|null |
|
paid_amount_e2 |
int |
|
partner |
array\|null |
|
partner_name |
string\|null |
|
partner_pod_pin |
string\|null |
|
partner_provider_id |
int\|null |
|
partner_validation_code |
array\|null |
|
partner_validation_url |
string\|null |
|
payment_attempting |
string\|null |
|
payment_balance_e2 |
int |
|
payment_debt_e2 |
int |
|
payment_error |
string\|null |
|
payment_types |
array |
|
payments |
Payment> |
|
pickup_delay_in_seconds |
int |
|
pickup_eta |
datetime |
|
pickup_eta_in_seconds |
int |
|
probable_eta |
datetime\|null |
|
promo_code |
CouponUsage\|null |
|
promo_code_e2 |
int |
|
promo_code_tax |
OrderTax\|null |
|
proofOfDeliveries |
ProofOfDelivery> |
|
providerPendingFees |
ProviderPendingFee> |
|
providerRatings |
ProviderRating> |
|
providers |
Provider> |
|
relatedBalanceMovements |
BalanceMovement> |
|
revenue_e2 |
int |
|
selected_payment_method |
SelectedPaymentMethod\|null |
|
service_charge |
array\|null |
|
service_fee_e2 |
int |
|
service_matches |
array\|null |
|
shopper |
Provider\|null |
|
shopper_attachments |
Collection |
|
shopper_fee_e2 |
int |
|
shopper_fee_to_pay_e2 |
int |
|
shopper_notes |
Collection |
|
shopper_snapshot |
Provider\|null |
|
snapshots |
OrderDataSnapshot> |
|
status_data |
array |
|
status_for_branch_admins |
string |
|
status_for_clients |
string |
|
status_for_company_admins |
string |
|
status_for_partners |
string |
|
status_for_payment |
string |
|
status_for_providers |
string |
|
status_for_shoppers |
string |
|
subtotal_discount_e2 |
int |
|
subtotal_promo_code_e2 |
int |
|
tab_groups |
array |
|
taxes |
OrderTax> |
|
taxes_for_branch |
Collection |
|
tracking_url |
string\|null |
|
weight |
int |
Crea una nueva órden. Este endpoint está deprecado y se debe usar el Carrito (Cart).
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/branches/{branchId}/clients/{clientId}/orders |
Authorization |
{
"receiver_name": "string|max:64",
"receiver_phone": "string|max:32",
"client_dni": "string|max:32",
"client_phone": "string|max:32",
"client_name": "string|max:128",
"client_email": "string|email:rfc,filter",
"is_gift": "boolean",
"client_latitude_e6": "required_without:client_address_id|integer|between:-90000000,90000000",
"client_longitude_e6": "required_with:client_latitude_e6||integer|between:-180000000,180000000",
"client_address": "string|max:512",
"client_address_id": "integer",
"pickup_latitude_e6": "integer|between:-90000000,90000000",
"pickup_longitude_e6": "integer|between:-180000000,180000000",
"pickup_address": "string|max:512",
"provider_id": "integer",
"scheduled_at": "date",
"use_local_tz": "boolean",
"notes": "string|max:255",
"goods": [
{
"good_id": "required|integer|exists:goods,id",
"quantity": "required|integer|min:1",
"units": "nullable|numeric|min:0.000001",
"provider_id": "integer",
"notes": "string|max:255",
"properties": [
{
"property_id": "required|integer",
"value": "required|string"
}
]
}
],
"subtotal_e2": "integer|min:0",
"service_charge_id": "nullable|integer",
"service_charge": "nullable|array",
"available_delivery_providers": "nullable|array",
"use_balance": "boolean",
"coupon_code": "nullable|string|min:5|max:20",
"cart_identifier": "integer|min:0",
"all_errors": "",
"simulate": "",
"force_scheduling": "boolean",
"force_providers": [
"integer"
]
}
{info} Soporta: Paginación Filters Carga dinámica
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/orders |
Authorization |
{info} Soporta: Paginación Filters Carga dinámica
Lista las órdenes de un grupo de comercios.
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/branch-groups/{branchGroupId}/orders |
Authorization |
{info} Soporta: Paginación Filters Carga dinámica
Lista las órdenes de un comercio
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/branches/{branchId}/orders |
Authorization |
{info} Soporta: Paginación Filters Carga dinámica
DLista las órdenes de un cliente.
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/clients/{clientId}/orders |
Authorization |
{info} Soporta: Filters
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/clients/{clientId}/orders/active |
Authorization |
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/providers/{providerId}/orders/available |
Authorization |
{info} Soporta: Paginación
Lista las órdenes creadas por un administrador.
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/admins/{adminId}/orders |
Authorization |
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/orders/{orderId}/order-histories |
Authorization |
{info} Soporta: Carga dinámica
Muestra los detalles de una orden
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/orders/{orderId} |
Authorization |
{info} Soporta: Paginación Filters Carga dinámica
Actualiza algunos datos de una orden
| Método | URI | Cabeceras |
|---|---|---|
| PATCH | /companies/{companyId}/orders/{orderId} |
Authorization |
{
"admin_note_id": "nullable|integer|min:1",
"admin_notes": "nullable|string|max:512"
}
{info} Soporta: Paginación Filters Carga dinámica
Crea una evidencia (imagen) y lo vincula a una nota de administrador de una Orden.
Se puede visualizar por el atributo de Orden: administrator_notes.attachments
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/add-attachment |
Authorization |
{
"admin_notes": "nullable|string|max:512",
"attachment": "nullable|image|mimes:jpeg,png,bmp|max:8192"
}
{info} Soporta: Paginación Filters Carga dinámica
Crea una evidencia (text) con su imagen y lo vincula a una nota de administrador de una Orden.
Se puede visualizar por el atributo de Orden: administrator_notes.attachments
| Método | URI | Cabeceras |
|---|---|---|
| POST | /orders/{orderId}/administrator-notes |
Authorization |
{
"admin_notes": "nullable|string|max:512",
"attachment": "nullable|image|mimes:jpeg,png,bmp|max:8192"
}
{info} Soporta: Paginación Filters Carga dinámica
Crea una evidencia (imagen) y una nota (texto) de un shopper y lo vincula a una orden.
Útil para subir facturas o evidencias de la compra.
Se puede visualizar por el atributo de Orden: shopper_notes.
Sólo disponible para el shopper asignado.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/add-shopper-notes |
Authorization |
{
"shopper_notes": [
{
"text": "nullable|string|max:512",
"attachments": [
"required|image|mimes:jpeg,png,bmp|max:8192"
]
}
]
}
{info} Soporta: Paginación Filters Carga dinámica
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/update-destination-address |
Authorization |
{
"client_latitude_e6": "required|integer|between:-90000000,90000000",
"client_longitude_e6": "required|integer|between:-180000000,180000000",
"client_address": "nullable|string|max:512",
"address_notes": "nullable|string|max:255",
"contact_name": "nullable|string|max:80",
"contact_phone": "nullable|string|max:20",
"contact_instructions": "nullable|string|max:1024"
}
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/batch-action/{action} |
Authorization |
{
"ids": [
"integer|min:1"
],
"payload": ""
}
Confirma una orden y le asigna un número de Orden.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-confirmed |
Authorization |
Marcar una orden como pagada por un administrador. Útil para resolver incidencias con pagos recibidos.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-paid |
Authorization |
{
"type": "string|in:gateway,form,post-payment,balance",
"name": "string",
"ref": "string"
}
Inicia una orden por el comercio si la orden no es apta para envíos.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-running |
Authorization |
Marca una orden como lista. Solo para órdenes no aptas para envíos.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-ready |
Authorization |
Finaliza una orden (entregada). Solo para órdenes no aptas para envíos.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-completed |
Authorization |
Cancela una orden. Si la orden ya está completada, se marcará como no entregada para efectos de facturación.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-canceled |
Authorization |
{
"reason": "required|string|max:64",
"target_user_type": {
"nullable": true,
"string": true
}
}
Permite avanzar una orden sin pagos. La orden se cobrará al momento de la entrega.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-post-payment |
Authorization |
{
"id": "nullable|string",
"currency_iso": "required_with:id|string|min:3|max:8",
"cash_amount_e2": "nullable|integer|min:1"
}
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-balance-payment |
Authorization |
Inicia la preparación de una orden (Por el comercio).
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-being-prepared |
Authorization |
Marca la orden como preparada y lista para ser entregada por el comercio; ya sea al delivery o al cliente.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-prepared |
Authorization |
{
"assign_shopper_as_deliverer": "nullable|boolean"
}
Mueve la orden al pool privado. El envío de la orden será manejado por el comercio.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-private-pool |
Authorization |
Mueve la orden al pool público. El envío de la orden puede ser asignado a cualquier flota de la plataforma.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-public-pool |
Authorization |
| Método | URI | Cabeceras |
|---|---|---|
| GET | /companies/{companyId}/orders/{orderId}/available-fleets |
Authorization |
Cambia la flota asignada al envío de una orden.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/set-selected-fleet |
Authorization |
{
"service_charge_id": "required|integer"
}
Envía una orden a pool. Esto permite la asignación de la orden según la configuración actual.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/send-to-pool |
Authorization |
{
"force": "bool"
}
Marca la orden como despachada sin asignación de repartidor.
Solo válido para órdenes creadas con entrega a cargo del comercio (is_no_provider_dispatch). Habilita la posterior completación de la orden.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /orders/{orderId}/set-dispatched-without-provider |
Authorization |
Excluye la orden de la facturación para que no sea pagada al comercio.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/exclude-invoices |
Authorization |
Incluye la orden en la facturación para que pueda ser pagada al comercio.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/include-invoices |
Authorization |
{info} Soporta: Paginación Filters Carga dinámica
Recalcula el envío de una orden según la nueva dirección de envío. Permite confirmar un cambio de dirección.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/check-destination-address |
Authorization |
{
"client_latitude_e6": "required|integer|between:-90000000,90000000",
"client_longitude_e6": "required|integer|between:-180000000,180000000"
}
Store a newly created resource in storage.
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/branches/{branchId}/orders |
Authorization |
{
"receiver_name": "string|max:64",
"receiver_phone": "string|max:32",
"client_dni": "string|max:32",
"client_phone": "string|max:32",
"client_name": "string|max:128",
"client_email": "string|email:rfc,filter",
"is_gift": "boolean",
"client_latitude_e6": "required_without:client_address_id|integer|between:-90000000,90000000",
"client_longitude_e6": "required_with:client_latitude_e6||integer|between:-180000000,180000000",
"client_address": "string|max:512",
"client_address_id": "integer",
"pickup_latitude_e6": "integer|between:-90000000,90000000",
"pickup_longitude_e6": "integer|between:-180000000,180000000",
"pickup_address": "string|max:512",
"provider_id": "integer",
"scheduled_at": "date",
"use_local_tz": "boolean",
"notes": "string|max:255",
"goods": [
{
"good_id": "required|integer|exists:goods,id",
"quantity": "required|integer|min:1",
"units": "nullable|numeric|min:0.000001",
"provider_id": "integer",
"notes": "string|max:255",
"properties": [
{
"property_id": "required|integer",
"value": "required|string"
}
]
}
],
"subtotal_e2": "integer|min:0",
"service_charge_id": "nullable|integer",
"service_charge": "nullable|array",
"available_delivery_providers": "nullable|array",
"use_balance": "boolean",
"coupon_code": "nullable|string|min:5|max:20",
"cart_identifier": "integer|min:0",
"all_errors": "",
"simulate": "",
"force_scheduling": "boolean",
"force_providers": [
"integer"
]
}
Asigna un shopper a una orden.
| Método | URI | Cabeceras |
|---|---|---|
| PUT | /companies/{companyId}/orders/{orderId}/shoppers/{providerId} |
Authorization |
Quita al Shopper de una orden. La orden queda libre para asignarla a otro Shopper.
| Método | URI | Cabeceras |
|---|---|---|
| DELETE | /companies/{companyId}/orders/{orderId}/shoppers/{providerId} |
Authorization |
Agrega un ajuste económico a una orden
| Método | URI | Cabeceras |
|---|---|---|
| POST | /companies/{companyId}/orders/{orderId}/adjust |
Authorization |
{
"amount_e2": "required|integer",
"description": "required|string|max:128",
"adjust_client_balance": "required|boolean",
"is_forced": "nullable|boolean"
}
allLogs HasMany ApiLogallOrderedGoodItems HasMany OrderedGoodallPayments HasMany PaymentassignedOrderProviders HasMany OrderProviderbids HasMany Bidbranch BelongsTo BranchbranchPendingFee HasOne BranchPendingFeebranchRating HasOne BranchRatingcancellationReason HasOne OrderCancellationReasoncashbacks HasMany CouponUsageclient BelongsTo ClientclientRating HasOne ClientRatingclientRatings HasMany ClientRatingcompany BelongsTo CompanycompanyActiveOrder HasOne CompanyActiveOrdercreator BelongsTo Admindiscounts HasMany CouponUsagediscountsAndCashbacks HasMany CouponUsagegeneralInvoiceItems HasMany GeneralInvoiceItemgoodRatings HasMany GoodRatinggoods HasMany Goodhistories HasMany OrderHistoryinvoiceDocumentItems HasMany InvoiceDocumentItemlogs HasMany ApiLogorderProviderServices HasMany OrderProviderServiceorderProviders HasMany OrderProviderorderedGoodItems HasMany OrderedGoodorderedGoodItemsWithPromo HasMany OrderedGoodpayments HasMany PaymentproofOfDeliveries HasMany ProofOfDeliveryproviderPendingFees HasMany ProviderPendingFeeproviderRatings HasMany ProviderRatingproviders HasMany ProviderrelatedBalanceMovements HasMany BalanceMovementshopper BelongsTo Providersnapshots HasMany OrderDataSnapshottaxes HasMany OrderTax