Artículos sobre: Integraciones

Diccionario de datos de API

Las cadenas de texto String, donde no se especifique la longitud del campo, están topadas a 255 caracteres.


Pedidos (SalesOrder)

Campo

Tipo

Detalle

id

Long

Identificador único del pedido

mobileDateCreated

DateTime

Fecha y hora de creación en app móvil

dateCreated

DateTime

Fecha y hora en la que el pedido llegó la BD del backend

totalSales

Double

Monto total del pedido, incluye impuestos

totalTax

Double

Monto total de los impuestos

totalBeforeTax

Double

Monto total del precio base antes de impuestos

scheduledDateForDelivery

DateTime

Fecha de entrega programada

exported

Boolean

Indica si el pedido ha sido exportado a Excel o no

sellerComment

String (2,000)

Comentario del vendedor al momento de capturar el pedido

latitude

Double

Latitud donde se levantó pedido (coordenadas). Formato decimal

longitude

Double

Longitud donde se levantó pedido (coordenadas). Formato decimal

accuracy

Double

Precisión con que se capturaron las coordenadas (metros)

tookInPlace

Boolean

Indica si el pedido se levantó en la ubicación del cliente o no

billed

Boolean

Indica si el pedido ha sido facturado o no

billable

Boolean

Indica si el cliente requiere factura para este pedido o no

routeSalePaymentType

String

Tipo de pago ("Crédito" o "Contado")

promoIds

String (Longtext)

Lista de identificadores únicos de las promociones aplicadas, separados por coma

promoNames

String (Longtext)

Lista de nombres de promociones separada por ',' de las promociones aplicada al pedido

networkSignalQuality

Integer

intensidad de la señal al momento de capturar el pedido en la app móvil (0-5)

creationSource

String

Fuente de origen donde se creó el pedido ( "WEB", "MOBILE" , "API" , "IMPORT")

deleted

Boolean

Indica si el pedido ha sido eliminado o no

dateDeleted

DateTime

Fecha en que se eliminó el pedido

deletedBy

Object

Ver detalles en tabla inferior

isEdited

Boolean

Indica si el pedido ha sido editado o no

editedFrom

Object

Si el pedido es editado, se almacena el pedido padre

salesType

String

Indica el tipo de pedido ("Preventa", "Venta en ruta" o "Devolución")

externalId

String

Referencia a sistemas terceros para la sincronización

operativeStatus

String

Estado operativo del pedido (PENDING_DELIVERY, ON_ROUTE, PARTIAL_DELIVERED_OPEN, PARTIAL_DELIVERED_CLOSED, DELIVERED_COMPLETE, RETURNED, CANCELLED, CLOSED)

prettyOperativeStatus

String

Estado operativo del pedido traducido al Español ( "Por entregar", "En ruta" , "Entrega parcial", "Entrega completa", "Devuelto", "Cancelado", "Cerrado")

lastDeliveryDate

Datetime

Fecha en que dicho pedido tuvo un intento de entrega exitoso

lastDeliveryAttempt

Datetime

Fecha en que dicho pedido tuvo un intento de entrega exitoso o fallido

errorMessageFromIntegration

String (Longtext)

Mensaje de error en caso de que exista para la sincronización de terceros sistemas

deliveredById

Long

ID del repartidor (usuario) que realizó la entrega que tiene asociada el pedido. Se asigna desde que se crea la entrega

type

Object

Ver detalles en tabla más abajo

priceList

Object

Ver detalles en tabla más abajo

createdBy

Object

Vendedor que creó el pedido. Usuario. Ver detalles en tabla más abajo

deletedBy

Object

Ver detalles en tabla más abajo

customer

Object

Ver detalles en tabla más abajo

items

Array

Ver detalles en tabla más abajo


customer

Object

Cliente del pedido

customer.id

Long

Identificador único del cliente

customer.code

String

Código del cliente

customer.description

String

Nombre del cliente

customer.enabled

Boolean

Indica si está habilitado o no el cliente

customer.balance

Double

Saldo del cliente

customer.credit

Double

Límite de crédito del cliente

customer.address

String

Dirección del cliente

customer.postalCode

String

Código postal del cliente

customer.neighborhood

String

Vecindario del cliente

customer.comments

String (2000)

Comentarios del cliente

customer.businessName

String

Nombre comercial del cliente

customer.cfdiUse

Object

Uso del CFDI para facturar en México

customer.fiscalRegime

Object

Régimen fiscal para facturar en México

customer.paymentForms

Object

Forma de pago

customer.zone

Object

Zona a la que pertenece el cliente

customer.zone.id

Long

Identificador únicao de la zona del cliente

customer.zone.description

String

Nombre de la zona del cliente

customer.zone.enabled

Boolean

Indica si está habilitada o no la zona del cliente

customer.zone.color

String

Color hexadécimal que identifica la zona

customer.zone.dateCreated

DateTime

Fecha de creación de la zona del cliente

customer.zone.lastUpdated

DateTime

Última fecha de actualización de la zona del cliente

customer.priceList

Object

Lista de precio del cliente, ver detalles más abajo


type

Object

Tipo de pedido

type.id

Long

Identificador único del tipo de pedido

type.description

String

Descripción del tipo de pedido

type.enabled

Boolean

Indica si está habilitado o no el tipo de pedido

type.dateCreated

DateTime

Fecha y hora de creación del tipo de pedido

type.lastUpdated

DateTime

Fecha y hora de la última modificación del tipo de pedido


priceList

Object

Lista de precio

priceList.id

Long

Identificador único de la lista de precio

priceList.code

String

Código de la lista de precio que creó el pedido

priceList.name

String

Nombre de la lista de precio

priceList.enabled

Boolean

Indica si está habilitado o no la lista de precio

priceList.dateCreated

DateTime

Fecha de creación del tipo de pedido

priceList.lastUpdated

DateTime

Fecha de la última modificación del tipo de pedido


createdBy

Object

Usuario que creó el pedido

createdBy.id

Long

Identificador único del usuario

createdBy.username

String

Nombre de usuario

createdBy.name

String

Nombre y apellidos del usuario

createdBy.enabled

Boolean

Indica si está habilitado o no el usuario

createdBy.pictureUrl

String

URL pública de la foto de perfil del usuario


deletedBy

Object

Usuario que eliminó el pedido

deletedBy.id

Long

Identificador único del usuario

deletedBy.username

String

Nombre de usuario

deletedBy.name

String

Nombre y apellidos del usuario

deletedBy.enabled

Boolean

Indica si está habilitado o no el usuario

deletedBy.pictureUrl

String

URL pública de la foto de perfil del usuario


items

Array

Lista de items en el pedido

item.id

Long

Identificador único del item del pedido

item.product

Object

Producto vendido, ver detalle mas abajo

item.price

Double

Precio del producto

item.quantity

Double

Cantidad vendida

item.total

Double

Total del precio del producto * cantidad vendida

item.tax

Object

Impuesto aplicado al producto, ver detalle más abajo

item.taxOptional

Object

Segundo impuesto aplicado al producto

item.compoundTax

Boolean

Indica si los impuestos son compuestos o no

item.delivered

Bigdecimal

Indica la cantidad entregada

item.isReturn

Boolean

Indica si es una devolución o no

item.isReward

Boolean

Indica si es un producto que se agregó por una promoción

item.promoIds

String

Lista de Ids separada por ',' de las promociones aplicada al producto

item.promoNames

String

Lista de nombres de promociones separada por ',' de las promociones aplicada al producto

item.discountPercentage

Double

Descuento aplicado al producto

item.returnReason

Long

Id de la razón de devolución del producto


product

Object

Producto del pedido

product.id

Long

Identificador único del producto

product.code

String

Identificador único por compañía del producto

product.description

String

Descripción completa del producto

product.price

Double

Precio del producto, incluido impuesto

product.basePrice

Double

Precio base del producto, antes de impuesto

product.quantity

Double

Cantidad de inventario en almacén

product.tax

Object

Impuesto aplicado al producto, ver detalle más abajo

product.taxOptional

Object

Segundo impuesto aplicado al producto

product.compoundTax

Boolean

Indica si los impuestos son compuestos o no

product.routingWeightLoad

Number

Carga de peso por unidad (Kg)

product.routingWeightVolume

Number

Carga de volumen por unidad (centímetros cúbicos)

product.enabled

Boolean

Indica si está habilitado o no

product.barcode

String

Código de barras del producto

product.applyDiscounts

Boolean

Indica si aplica descuento o no

product.pictureUrl

String

URL pública de la imagen del producto

product.satProductCode

String

Código del producto SAT para facturación en México

product.satUnitCode

String

Unidad del producto SAT para facturación en México

product.minimumPrice

Double

Precio mínimo del producto

product.externalId

String

Id externo para emplear en terceros sistema para la sincronización de datos

product.category

Object

Categoría del producto

product.category.id

Long

Identificador único de la categoría del producto

product.category.description

String

Descripción de la categoría del producto

product.category.enabled

Boolean

Indica si está habilitado o no la categoría del producto

product.category.dateCreated

DateTime

Fecha de creación

product.category.lastUpdated

DateTime

Fecha de la última modificación

product.family

Object

Familia del producto

product.family.id

Long

Identificador único de la categoría del producto

product.family.description

String

Descripción de la familia del producto

product.family.enabled

Boolean

Indica si está habilitado o no la familia del producto


Actualizado el: 06/05/2025

¿Este artículo te resultó útil?

Comparte tu opinión

Cancelar

¡Gracias!