Company
Representa a una compañía o negocio en particular, con sus productos y servicios, sus clientes,
y sus configuraciones independientes.
Modelo Company
{
"id": 116,
"name": "Zupper by Ridery",
"email": "noreply@dondemand.io",
"domain": "panel-dev",
"custom_domain": "dondemand.io",
"expires_at": "2026-05-02 12:37:54",
"extension_days": 0,
"options": 1265633681,
"plan": 2147483647,
"enabled": true,
"strings_json": {
"strings": [],
"version": 1
},
"styles_json": {
"styles": {
"color_primary": "/docs/3/company#42b029",
"color_accent": "/docs/3/company#42b029",
"company_logo": "https://dondemand-dev.sfo3.cdn.digitaloceanspaces.com/companies/69/logo/logo_116_1740417437.png",
"company_logo_inv": "https://dondemand-dev.sfo3.cdn.digitaloceanspaces.com/companies/69/logo/logo_inv_116_1728100305.png"
},
"version": 40
},
"default_iso_lang": "es",
"created_at": "2020-04-20 15:24:38",
"updated_at": "2025-05-02 12:38:01",
"deleted_at": null,
"country_iso": "ve",
"time_zone_offset": "-04:00",
"can_providers_pick_deliveries_from_pool": null,
"can_providers_confirm_deliveries_from_clients": null,
"can_clients_pick_providers_for_deliveries": null,
"can_clients_choose_deliveries_after_provider_confirmation": null,
"can_providers_confirm_deliveries_from_admins": null,
"can_admins_choose_deliveries_after_provider_confirmation": null,
"enable_delivery_orders_confirmation_by_admins_before_payment": null,
"can_providers_forfeit_from_assigned_deliveries": null,
"enable_pickups": null,
"disable_deliveries": null,
"disable_deliveries_scheduling": null,
"enable_bot_for_deliveries": null,
"can_providers_pick_services_from_pool": null,
"can_providers_confirm_services_from_clients": null,
"can_clients_pick_providers_for_services": null,
"can_clients_choose_services_after_provider_confirmation": null,
"can_providers_confirm_services_from_admins": null,
"can_admins_choose_services_after_provider_confirmation": null,
"enable_service_orders_confirmation_by_admins_before_payment": null,
"can_providers_forfeit_from_assigned_services": null,
"enable_services_on_branch_location": null,
"disable_services_on_client_location": null,
"disable_services_scheduling": null,
"enable_bot_for_services": null,
"enable_pod_code": null,
"enable_pod_pictures": null,
"enable_pod_forms": null,
"enable_pod_signature": null,
"enabled_pods": null,
"enable_bot_for_shoppers": null,
"settings": {
"uid": "J505728482",
"slogan": "Powered by DonDemand",
"pay_in_store": true,
"enable_invoices": true,
"enable_multi_providers": false,
"enable_phone_login": true,
"enable_coupons": true,
"contact_phone": "+584148440652",
"contact_phone_whatsapp": "+584141942279",
"disable_balance": false,
"is_marketplace": true
}
}
| Atributo |
Tipo |
Descripción |
id |
int |
- |
name |
string |
- |
email |
string |
- |
domain |
string |
- |
custom_domain |
string\|null |
- |
expires_at |
datetime |
- |
extension_days |
int |
- |
options |
int |
- |
plan |
int |
- |
enabled |
bool |
- |
strings_json |
object |
- |
styles_json |
object |
- |
default_iso_lang |
string |
- |
created_at |
datetime\|null |
- |
updated_at |
datetime\|null |
- |
country_iso |
string |
- |
time_zone_offset |
string |
- |
can_providers_pick_deliveries_from_pool |
bool |
BitMask (({@link self::options} & 0x1) !== 0) |
can_providers_confirm_deliveries_from_clients |
bool |
BitMask (({@link self::options} & 0x2) !== 0) |
can_clients_pick_providers_for_deliveries |
bool |
BitMask (({@link self::options} & 0x4) !== 0) |
can_clients_choose_deliveries_after_provider_confirmation |
bool |
BitMask (({@link self::options} & 0x8) !== 0) |
can_providers_confirm_deliveries_from_admins |
bool |
BitMask (({@link self::options} & 0x10) !== 0) |
can_admins_choose_deliveries_after_provider_confirmation |
bool |
BitMask (({@link self::options} & 0x20) !== 0) |
enable_delivery_orders_confirmation_by_admins_before_payment |
bool |
BitMask (({@link self::options} & 0x40) !== 0) |
can_providers_forfeit_from_assigned_deliveries |
bool |
BitMask (({@link self::options} & 0x80) !== 0) |
enable_pickups |
bool |
BitMask (({@link self::options} & 0x100) !== 0) |
disable_deliveries |
bool |
BitMask (({@link self::options} & 0x200) !== 0) |
disable_deliveries_scheduling |
bool |
BitMask (({@link self::options} & 0x400) !== 0) |
enable_bot_for_deliveries |
bool |
BitMask (({@link self::options} & 0x800) !== 0) |
can_providers_pick_services_from_pool |
bool |
BitMask (({@link self::options} & 0x1000) !== 0) |
can_providers_confirm_services_from_clients |
bool |
BitMask (({@link self::options} & 0x2000) !== 0) |
can_clients_pick_providers_for_services |
bool |
BitMask (({@link self::options} & 0x4000) !== 0) |
can_clients_choose_services_after_provider_confirmation |
bool |
BitMask (({@link self::options} & 0x8000) !== 0) |
can_providers_confirm_services_from_admins |
bool |
BitMask (({@link self::options} & 0x10000) !== 0) |
can_admins_choose_services_after_provider_confirmation |
bool |
BitMask (({@link self::options} & 0x20000) !== 0) |
enable_service_orders_confirmation_by_admins_before_payment |
bool |
BitMask (({@link self::options} & 0x40000) !== 0) |
can_providers_forfeit_from_assigned_services |
bool |
BitMask (({@link self::options} & 0x80000) !== 0) |
enable_services_on_branch_location |
bool |
BitMask (({@link self::options} & 0x100000) !== 0) |
disable_services_on_client_location |
bool |
BitMask (({@link self::options} & 0x200000) !== 0) |
disable_services_scheduling |
bool |
BitMask (({@link self::options} & 0x400000) !== 0) |
enable_bot_for_services |
bool |
BitMask (({@link self::options} & 0x800000) !== 0) |
enable_pod_code |
bool |
BitMask (({@link self::options} & 0x1000000) !== 0) |
enable_pod_pictures |
bool |
BitMask (({@link self::options} & 0x2000000) !== 0) |
enable_pod_forms |
bool |
BitMask (({@link self::options} & 0x4000000) !== 0) |
enable_pod_signature |
bool |
BitMask (({@link self::options} & 0x8000000) !== 0) |
enabled_pods |
int |
BitMask (({@link self::options} & 0xf000000) >> 24) |
enable_bot_for_shoppers |
bool |
BitMask (({@link self::options} & 0x40000000) !== 0) |
settings |
array |
- |
Insertar Company
| Método |
URI |
Cabeceras |
| POST |
/companies |
Authorization |
{
"company": {
"name": "required|max:64",
"domain": "required|max:32|domain",
"custom_domain": "max:255|url",
"email": "required|email:rfc,filter|max:64",
"folder_name": "required|string",
"options": "numeric",
"plan": "numeric",
"default_iso_lang": "string|size:2",
"country_iso": "max:2|string",
"time_zone_offset": {
"string": true,
"regex": "/^[\+\-]([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"can_providers_pick_deliveries_from_pool": "nullable|boolean",
"can_providers_confirm_deliveries_from_clients": "nullable|boolean",
"can_clients_pick_providers_for_deliveries": "nullable|boolean",
"can_clients_choose_deliveries_after_provider_confirmation": "nullable|boolean",
"can_providers_confirm_deliveries_from_admins": "nullable|boolean",
"can_admins_choose_deliveries_after_provider_confirmation": "nullable|boolean",
"enable_delivery_orders_confirmation_by_admins_before_payment": "nullable|boolean",
"can_providers_forfeit_from_assigned_deliveries": "nullable|boolean",
"enable_pickups": "nullable|boolean",
"disable_deliveries": "nullable|boolean",
"disable_deliveries_scheduling": "nullable|boolean",
"enable_bot_for_deliveries": "nullable|boolean",
"can_providers_pick_services_from_pool": "nullable|boolean",
"can_providers_confirm_services_from_clients": "nullable|boolean",
"can_clients_pick_providers_for_services": "nullable|boolean",
"can_clients_choose_services_after_provider_confirmation": "nullable|boolean",
"can_providers_confirm_services_from_admins": "nullable|boolean",
"can_admins_choose_services_after_provider_confirmation": "nullable|boolean",
"enable_service_orders_confirmation_by_admins_before_payment": "nullable|boolean",
"can_providers_forfeit_from_assigned_services": "nullable|boolean",
"enable_services_on_branch_location": "nullable|boolean",
"disable_services_on_client_location": "nullable|boolean",
"disable_services_scheduling": "nullable|boolean",
"enable_bot_for_services": "nullable|boolean",
"enable_pod_code": "nullable|boolean",
"enable_pod_pictures": "nullable|boolean",
"enable_pod_forms": "nullable|boolean",
"enable_pod_signature": "nullable|boolean",
"enabled_pods": "nullable|integer|min:0|max:15",
"enable_bot_for_shoppers": "nullable|boolean"
},
"user": {
"name": "required|max:64",
"email": "required|email:rfc,filter",
"phone": "required"
}
}
Listar Company
{info} Soporta:
Filters
Carga dinámica
Paginación
| Método |
URI |
Cabeceras |
| GET |
/companies |
Authorization |
Listar Setting
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/settings |
Authorization |
Mostrar Company
Mostrar Domain
{info} Soporta:
Carga dinámica
| Método |
URI |
Cabeceras |
| GET |
/companies/domain/{domain} |
N/A |
{
"updated_at": "date"
}
Mostrar Domain
{info} Soporta:
Carga dinámica
| Método |
URI |
Cabeceras |
| GET |
/companies/domain/{domain} |
N/A |
{
"updated_at": "date"
}
Mostrar TermsOfService
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/terms-of-service |
N/A |
Mostrar Branch DayTime
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/branches/{branchId}/day-time |
N/A |
{
"updated_at": "date"
}
Mostrar Branch DayTime
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/branches/{branchId}/day-time |
N/A |
{
"updated_at": "date"
}
Actualizar Company
| Método |
URI |
Cabeceras |
| PATCH |
/companies/{companyId} |
Authorization |
{
"name": "max:64",
"domain": "max:32|domain",
"custom_domain": "max:255|url",
"email": "email:rfc,filter|max:64",
"folder_name": "string",
"options": "numeric",
"plan": "numeric",
"default_iso_lang": "string|size:2",
"country_iso": "max:2|string",
"time_zone_offset": {
"string": true,
"regex": "/^[\+\-]([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"can_providers_pick_deliveries_from_pool": "nullable|boolean",
"can_providers_confirm_deliveries_from_clients": "nullable|boolean",
"can_clients_pick_providers_for_deliveries": "nullable|boolean",
"can_clients_choose_deliveries_after_provider_confirmation": "nullable|boolean",
"can_providers_confirm_deliveries_from_admins": "nullable|boolean",
"can_admins_choose_deliveries_after_provider_confirmation": "nullable|boolean",
"enable_delivery_orders_confirmation_by_admins_before_payment": "nullable|boolean",
"can_providers_forfeit_from_assigned_deliveries": "nullable|boolean",
"enable_pickups": "nullable|boolean",
"disable_deliveries": "nullable|boolean",
"disable_deliveries_scheduling": "nullable|boolean",
"enable_bot_for_deliveries": "nullable|boolean",
"can_providers_pick_services_from_pool": "nullable|boolean",
"can_providers_confirm_services_from_clients": "nullable|boolean",
"can_clients_pick_providers_for_services": "nullable|boolean",
"can_clients_choose_services_after_provider_confirmation": "nullable|boolean",
"can_providers_confirm_services_from_admins": "nullable|boolean",
"can_admins_choose_services_after_provider_confirmation": "nullable|boolean",
"enable_service_orders_confirmation_by_admins_before_payment": "nullable|boolean",
"can_providers_forfeit_from_assigned_services": "nullable|boolean",
"enable_services_on_branch_location": "nullable|boolean",
"disable_services_on_client_location": "nullable|boolean",
"disable_services_scheduling": "nullable|boolean",
"enable_bot_for_services": "nullable|boolean",
"enable_pod_code": "nullable|boolean",
"enable_pod_pictures": "nullable|boolean",
"enable_pod_forms": "nullable|boolean",
"enable_pod_signature": "nullable|boolean",
"enabled_pods": "nullable|integer|min:0|max:15",
"enable_bot_for_shoppers": "nullable|boolean",
"custom_json": {
"subscription": "array"
}
}
Actualizar Setting
| Método |
URI |
Cabeceras |
| PATCH |
/companies/{companyId}/settings |
Authorization |
{
"uid": "string|max:64",
"slogan": "string|max:80",
"mail_footer": "string|max:255",
"mail_from": "email:rfc,filter|max:64",
"pay_in_store": "boolean",
"enable_multi_providers": "boolean",
"enable_invoices": "boolean",
"enable_phone_login": "boolean",
"enable_coupons": "boolean",
"invoice_format": {
"head": "required_with:invoice_format|string",
"body": "required_with:invoice_format|string",
"item": "required_with:invoice_format|string",
"date_format": "required_with:invoice_format|string",
"paper": "required_with:invoice_format|string|max:32",
"orientation": "required_with:invoice_format|string|in:portrait,landscape"
},
"terms_of_service": "string",
"nearby_branches_distance": "integer|min:1000",
"nearby_providers_distance": "integer|min:1000",
"provider_collecting_distance": "integer|min:5",
"provider_arriving_distance": "integer|min:5",
"tip_threshold": "integer|min:0",
"min_nearby_branches_count": "integer|min:1",
"max_nearby_branches_count": "integer|min:1|gte:min_nearby_branches_count",
"subcategories_count": "integer|min:1",
"branch_invoice_tax_name": "nullable|string|min:1",
"branch_invoice_tax_prc": "nullable|numeric|min:0.0|max:1.0",
"branch_closing_soon_message_delay": "nullable|integer|min:5|max:60",
"assignable_orders_mask": "integer|min:0",
"auto_assign_delay_minutes": "integer|min:0",
"auto_assign_prepared_mode": "boolean",
"auto_assign_bid_count": "integer|min:0",
"auto_assign_bid_attempts": "integer|min:0",
"order_expiration_minutes": "integer|min:0",
"cancel_on_payment_failure": "boolean",
"contact_phone": "string|max:32",
"contact_phone_whatsapp": "string|max:32",
"disable_reports": "boolean",
"default_promoted_banner": "image|mimes:jpeg,png|max:8192",
"disable_balance": "boolean",
"sms_providers": "array",
"sms_notifications_enabled": "boolean",
"sms_expiration_in_minutes": "integer|min:2",
"sms_cooldown_in_seconds": "integer|min:15",
"sms_enabled_for_clients_tracking": "boolean",
"telegram_token": "string",
"whatsapp_phone_id": "string",
"whatsapp_messaging_token": "string",
"checkout_disclaimer": "string",
"qr_logo": "nullable|string",
"use_providers_balance_payouts": "nullable|boolean",
"google_account_json": "nullable|array",
"bancamiga_settings": "nullable|array",
"linked_servers": "nullable|array",
"first_purchase_bonus_e2": "integer|min:0",
"system_expiration_hours": "integer|min:0",
"disable_payment_emails": "boolean",
"is_verification_required": "boolean",
"is_full_verification_required": "boolean",
"sockette_keys": "array",
"service_app_name": "nullable|string",
"service_app_modifiers": [
{
"is_enabled": "boolean",
"name": "required|string|max:32",
"label": "string|max:32",
"description": "string",
"layer": "integer|min:0|max:255",
"price_min_e2": "integer|min:0",
"human_price_min_e2": "numeric|min:0.0",
"price_max_e2": "integer",
"human_price_max_e2": "numeric",
"hour_beg": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"hour_end": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"conditions": "array",
"payment_methods": [
"required|string"
],
"payment_currencies": [
"required|string"
]
}
],
"taxes": [
{
"is_enabled": "boolean",
"name": "required|string|max:32",
"label": "string|max:32",
"description": "string",
"layer": "integer|min:0|max:255",
"price_min_e2": "integer|min:0",
"human_price_min_e2": "numeric|min:0.0",
"price_max_e2": "integer",
"human_price_max_e2": "numeric",
"hour_beg": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"hour_end": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"conditions": "array",
"payment_methods": [
"required|string"
],
"payment_currencies": [
"required|string"
]
}
],
"sms_default_provider": "string|in:interconectados,plivo,twilio,twilio_whatsapp,roraima_conectium",
"sms_login_provider": "string|in:interconectados,plivo,twilio,twilio_whatsapp,roraima_conectium"
}
Actualizar Setting
| Método |
URI |
Cabeceras |
| POST |
/companies/{companyId}/settings |
Authorization |
{
"uid": "string|max:64",
"slogan": "string|max:80",
"mail_footer": "string|max:255",
"mail_from": "email:rfc,filter|max:64",
"pay_in_store": "boolean",
"enable_multi_providers": "boolean",
"enable_invoices": "boolean",
"enable_phone_login": "boolean",
"enable_coupons": "boolean",
"invoice_format": {
"head": "required_with:invoice_format|string",
"body": "required_with:invoice_format|string",
"item": "required_with:invoice_format|string",
"date_format": "required_with:invoice_format|string",
"paper": "required_with:invoice_format|string|max:32",
"orientation": "required_with:invoice_format|string|in:portrait,landscape"
},
"terms_of_service": "string",
"nearby_branches_distance": "integer|min:1000",
"nearby_providers_distance": "integer|min:1000",
"provider_collecting_distance": "integer|min:5",
"provider_arriving_distance": "integer|min:5",
"tip_threshold": "integer|min:0",
"min_nearby_branches_count": "integer|min:1",
"max_nearby_branches_count": "integer|min:1|gte:min_nearby_branches_count",
"subcategories_count": "integer|min:1",
"branch_invoice_tax_name": "nullable|string|min:1",
"branch_invoice_tax_prc": "nullable|numeric|min:0.0|max:1.0",
"branch_closing_soon_message_delay": "nullable|integer|min:5|max:60",
"assignable_orders_mask": "integer|min:0",
"auto_assign_delay_minutes": "integer|min:0",
"auto_assign_prepared_mode": "boolean",
"auto_assign_bid_count": "integer|min:0",
"auto_assign_bid_attempts": "integer|min:0",
"order_expiration_minutes": "integer|min:0",
"cancel_on_payment_failure": "boolean",
"contact_phone": "string|max:32",
"contact_phone_whatsapp": "string|max:32",
"disable_reports": "boolean",
"default_promoted_banner": "image|mimes:jpeg,png|max:8192",
"disable_balance": "boolean",
"sms_providers": "array",
"sms_notifications_enabled": "boolean",
"sms_expiration_in_minutes": "integer|min:2",
"sms_cooldown_in_seconds": "integer|min:15",
"sms_enabled_for_clients_tracking": "boolean",
"telegram_token": "string",
"whatsapp_phone_id": "string",
"whatsapp_messaging_token": "string",
"checkout_disclaimer": "string",
"qr_logo": "nullable|string",
"use_providers_balance_payouts": "nullable|boolean",
"google_account_json": "nullable|array",
"bancamiga_settings": "nullable|array",
"linked_servers": "nullable|array",
"first_purchase_bonus_e2": "integer|min:0",
"system_expiration_hours": "integer|min:0",
"disable_payment_emails": "boolean",
"is_verification_required": "boolean",
"is_full_verification_required": "boolean",
"sockette_keys": "array",
"service_app_name": "nullable|string",
"service_app_modifiers": [
{
"is_enabled": "boolean",
"name": "required|string|max:32",
"label": "string|max:32",
"description": "string",
"layer": "integer|min:0|max:255",
"price_min_e2": "integer|min:0",
"human_price_min_e2": "numeric|min:0.0",
"price_max_e2": "integer",
"human_price_max_e2": "numeric",
"hour_beg": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"hour_end": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"conditions": "array",
"payment_methods": [
"required|string"
],
"payment_currencies": [
"required|string"
]
}
],
"taxes": [
{
"is_enabled": "boolean",
"name": "required|string|max:32",
"label": "string|max:32",
"description": "string",
"layer": "integer|min:0|max:255",
"price_min_e2": "integer|min:0",
"human_price_min_e2": "numeric|min:0.0",
"price_max_e2": "integer",
"human_price_max_e2": "numeric",
"hour_beg": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"hour_end": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"conditions": "array",
"payment_methods": [
"required|string"
],
"payment_currencies": [
"required|string"
]
}
],
"sms_default_provider": "string|in:interconectados,plivo,twilio,twilio_whatsapp,roraima_conectium",
"sms_login_provider": "string|in:interconectados,plivo,twilio,twilio_whatsapp,roraima_conectium"
}
Eliminar Company
| Método |
URI |
Cabeceras |
| DELETE |
/companies/{companyId} |
Authorization |
Restaurar Company
| Método |
URI |
Cabeceras |
| POST |
/companies/{companyId}/restore |
Authorization |
Acciones de Company
Resolve
{info} Soporta:
Carga dinámica
| Método |
URI |
Cabeceras |
| GET |
/domains/{domainToResolve} |
N/A |
Show Domain
{info} Soporta:
Carga dinámica
| Método |
URI |
Cabeceras |
| GET |
/branches/domain/{domainName} |
N/A |
Show Domain
{info} Soporta:
Carga dinámica
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/branch-groups/domain/{domainName} |
N/A |
Update Styles
| Método |
URI |
Cabeceras |
| POST |
/companies/{companyId}/styles |
Authorization |
{
"color_primary": {
"string": true,
"regex": "/^#(?:[0-9a-fA-F]{3}){1,2}$/"
},
"color_accent": {
"string": true,
"regex": "/^#(?:[0-9a-fA-F]{3}){1,2}$/"
},
"company_logo": "image|mimes:jpeg,png|max:1024",
"company_logo_inv": "image|mimes:jpeg,png|max:1024"
}
List
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/banks |
N/A |
{
"image_mode": "string|in:list,square",
"filter": "string|in:mobile_payment,transfer,ci"
}
Index Allowed
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/allowed-settings |
Authorization |
Calculate
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/branches/{branchId}/calculate-fees |
Authorization |
{
"latitude_e6": "required|integer|between:-90000000,90000000",
"longitude_e6": "required|integer|between:-180000000,180000000",
"subtotal_e2": "integer|min:0",
"subtotal_full_e2": "integer|min:0",
"base_price_e2": "integer|min:0",
"balance_e2": "integer",
"selected_delivery_id": "nullable|integer",
"payment_method_type": "string|in:gateway,form,post-payment,balance",
"payment_method_id": "nullable",
"payment_method_currency_iso": "string|min:3|max:8",
"coupon_id": "nullable|integer",
"is_gift": "nullable|boolean",
"client_id": "integer",
"items": [
{
"good_id": "required|integer|exists:goods,id",
"quantity": "required|integer|min:1",
"provider_id": "integer",
"properties": [
{
"property_id": "required|integer",
"value": "required|string"
}
]
}
],
"goods": [
"integer"
],
"good_ids": {
"string": true,
"regex": "/^[0-9]+(,[0-9]+)*$/"
},
"time": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"datetime": "date|after:now",
"use_local_tz": "boolean"
}
Calculate
| Método |
URI |
Cabeceras |
| POST |
/companies/{companyId}/branches/{branchId}/calculate-fees |
Authorization |
{
"latitude_e6": "required|integer|between:-90000000,90000000",
"longitude_e6": "required|integer|between:-180000000,180000000",
"subtotal_e2": "integer|min:0",
"subtotal_full_e2": "integer|min:0",
"base_price_e2": "integer|min:0",
"balance_e2": "integer",
"selected_delivery_id": "nullable|integer",
"payment_method_type": "string|in:gateway,form,post-payment,balance",
"payment_method_id": "nullable",
"payment_method_currency_iso": "string|min:3|max:8",
"coupon_id": "nullable|integer",
"is_gift": "nullable|boolean",
"client_id": "integer",
"items": [
{
"good_id": "required|integer|exists:goods,id",
"quantity": "required|integer|min:1",
"provider_id": "integer",
"properties": [
{
"property_id": "required|integer",
"value": "required|string"
}
]
}
],
"goods": [
"integer"
],
"good_ids": {
"string": true,
"regex": "/^[0-9]+(,[0-9]+)*$/"
},
"time": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"datetime": "date|after:now",
"use_local_tz": "boolean"
}
Calculate V2
| Método |
URI |
Cabeceras |
| POST |
/companies/{companyId}/branches/{branch}/calculate-fees-for-all |
Authorization |
{
"latitude_e6": "required|integer|between:-90000000,90000000",
"longitude_e6": "required|integer|between:-180000000,180000000",
"subtotal_e2": "integer|min:0",
"subtotal_full_e2": "integer|min:0",
"base_price_e2": "integer|min:0",
"balance_e2": "integer",
"selected_delivery_id": "nullable|integer",
"payment_method_type": "string|in:gateway,form,post-payment,balance",
"payment_method_id": "nullable",
"payment_method_currency_iso": "string|min:3|max:8",
"coupon_id": "nullable|integer",
"is_gift": "nullable|boolean",
"client_id": "integer",
"items": [
{
"good_id": "required|integer|exists:goods,id",
"quantity": "required|integer|min:1",
"provider_id": "integer",
"properties": [
{
"property_id": "required|integer",
"value": "required|string"
}
]
}
],
"goods": [
"integer"
],
"good_ids": {
"string": true,
"regex": "/^[0-9]+(,[0-9]+)*$/"
},
"time": {
"string": true,
"regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
},
"datetime": "date|after:now",
"use_local_tz": "boolean"
}
Report
{info} Soporta:
Paginación
Filters
Carga dinámica
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/earnings-report |
N/A |
Report
{info} Soporta:
Paginación
Filters
Carga dinámica
| Método |
URI |
Cabeceras |
| GET |
/companies/{companyId}/payments-report |
N/A |
Report
| Método |
URI |
Cabeceras |
| POST |
/companies/{companyId}/bancamiga-report |
N/A |
{
"file": "required|file|mimes:xlsx,xlsm,xltx,xltm,xls,xlt,ods,ots,slk,xml,gnumeric,htm,html,csv,tsv,txt",
"csv_settings": {
"delimiter": "string",
"enclosure": "string",
"line_ending": "string",
"use_bom": "boolean",
"include_separator_line": "boolean",
"excel_compatibility": "boolean",
"escape_character": "string",
"contiguous": "boolean",
"input_encoding": "string",
"output_encoding": "string"
}
}
Enlaces de Company