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)


CampoTipoDetalle
idLongIdentificador único del pedido
mobileDateCreatedDateTimeFecha y hora de creación en app móvil
dateCreatedDateTimeFecha y hora en la que el pedido llegó la BD del backend
totalSalesDoubleMonto total del pedido, incluye impuestos
totalTaxDoubleMonto total de los impuestos
totalBeforeTaxDoubleMonto total del precio base antes de impuestos
scheduledDateForDeliveryDateTimeFecha de entrega programada
exportedBooleanIndica si el pedido ha sido exportado a Excel o no
sellerCommentString (2,000)Comentario del vendedor al momento de capturar el pedido
latitudeDoubleLatitud donde se levantó pedido (coordenadas). Formato decimal
longitudeDoubleLongitud donde se levantó pedido (coordenadas). Formato decimal
accuracyDoublePrecisión con que se capturaron las coordenadas (metros)
tookInPlaceBooleanIndica si el pedido se levantó en la ubicación del cliente o no
billedBooleanIndica si el pedido ha sido facturado o no
billableBooleanIndica si el cliente requiere factura para este pedido o no
routeSalePaymentTypeStringTipo de pago ("Crédito" o "Contado")
promoIdsString (Longtext)Lista de identificadores únicos de las promociones aplicadas, separados por coma
promoNamesString (Longtext)Lista de nombres de promociones separada por ',' de las promociones aplicada al pedido
networkSignalQualityIntegerintensidad de la señal al momento de capturar el pedido en la app móvil (0-5)
creationSourceStringFuente de origen donde se creó el pedido ( "WEB", "MOBILE", "PRESTASHOP" , "API" , "IMPORT")
deletedBooleanIndica si el pedido ha sido eliminado o no
dateDeletedDateTimeFecha en que se eliminó el pedido
deletedByObjectVer detalles en tabla inferior
isEditedBooleanIndica si el pedido ha sido editado o no
editedFromObjectSi el pedido es editado, se almacena el pedido padre
salesTypeStringIndica el tipo de pedido ("Preventa", "Venta en ruta" o "Devolución")
externalIdStringReferencia a sistemas terceros para la sincronización
operativeStatusStringEstado operativo del pedido (PENDING_DELIVERY, ON_ROUTE, PARTIAL_DELIVERED_OPEN, PARTIAL_DELIVERED_CLOSED, DELIVERED_COMPLETE, RETURNED, CANCELLED, CLOSED)
prettyOperativeStatusStringEstado operativo del pedido traducido al Español ( "Por entregar", "En ruta" , "Entrega parcial", "Entrega completa", "Devuelto", "Cancelado", "Cerrado")
errorMessageFromIntegrationString (Longtext)Mensaje de error en caso de que exista para la sincronización de terceros sistemas
deliveredByIdLongID del usuario que realizó la entrega que tiene asociada el pedido
typeObjectVer detalles en tabla más abajo
priceListObjectVer detalles en tabla más abajo
createdByObjectVer detalles en tabla más abajo
deletedByObjectVer detalles en tabla más abajo
customerObjectVer detalles en tabla más abajo
itemsArrayVer detalles en tabla más abajo


customerObjectCliente del pedido
customer.idLongIdentificador único del cliente
customer.codeStringCódigo del cliente
customer.descriptionStringNombre del cliente
customer.enabledBooleanIndica si está habilitado o no el cliente
customer.balanceDoubleSaldo del cliente
customer.creditDoubleLímite de crédito del cliente
customer.addressStringDirección del cliente
customer.postalCodeStringCódigo postal del cliente
customer.neighborhoodStringVecindario del cliente
customer.commentsString (2000)Comentarios del cliente
customer.businessNameStringNombre comercial del cliente
customer.cfdiUseObjectUso del CFDI para facturar en México
customer.fiscalRegimeObjectRégimen fiscal para facturar en México
customer.paymentFormsObjectForma de pago
customer.zoneObjectZona a la que pertenece el cliente
customer.zone.idLongIdentificador únicao de la zona del cliente
customer.zone.descriptionStringNombre de la zona del cliente
customer.zone.enabledBooleanIndica si está habilitada o no la zona del cliente
customer.zone.colorStringColor hexadécimal que identifica la zona
customer.zone.dateCreatedDateTimeFecha de creación de la zona del cliente
customer.zone.lastUpdatedDateTimeÚltima fecha de actualización de la zona del cliente
customer.priceListObjectLista de precio del cliente, ver detalles más abajo


typeObjectTipo de pedido
type.idLongIdentificador único del tipo de pedido
type.descriptionStringDescripción del tipo de pedido
type.enabledBooleanIndica si está habilitado o no el tipo de pedido
type.dateCreatedDateTimeFecha y hora de creación del tipo de pedido
type.lastUpdatedDateTimeFecha y hora de la última modificación del tipo de pedido


priceListObjectLista de precio
priceList.idLongIdentificador único de la lista de precio
priceList.codeStringCódigo de la lista de precio que creó el pedido
priceList.nameStringNombre de la lista de precio
priceList.enabledBooleanIndica si está habilitado o no la lista de precio
priceList.dateCreatedDateTimeFecha de creación del tipo de pedido
priceList.lastUpdatedDateTimeFecha de la última modificación del tipo de pedido


createdByObjectUsuario que creó el pedido
createdBy.idLongIdentificador único del usuario
createdBy.usernameStringNombre de usuario
createdBy.nameStringNombre y apellidos del usuario
createdBy.enabledBooleanIndica si está habilitado o no el usuario
createdBy.pictureUrlStringURL pública de la foto de perfil del usuario


deletedByObjectUsuario que eliminó el pedido
deletedBy.idLongIdentificador único del usuario
deletedBy.usernameStringNombre de usuario
deletedBy.nameStringNombre y apellidos del usuario
deletedBy.enabledBooleanIndica si está habilitado o no el usuario
deletedBy.pictureUrlStringURL pública de la foto de perfil del usuario


itemsArrayLista de items en el pedido
item.idLongIdentificador único del item del pedido
item.productObjectProducto vendido, ver detalle mas abajo
item.priceDoublePrecio del producto
item.quantityDoubleCantidad vendida
item.totalDoubleTotal del precio del producto * cantidad vendida
item.taxObjectImpuesto aplicado al producto, ver detalle más abajo
item.taxOptionalObjectSegundo impuesto aplicado al producto
item.compoundTaxBooleanIndica si los impuestos son compuestos o no
item.deliveredBooleanIndica si está entregado o no
item.isReturnBooleanIndica si es una devolución o no
item.isRewardBooleanIndica si es un producto que se agregó por una promoción
item.promoIdsStringLista de Ids separada por ',' de las promociones aplicada al producto
item.promoNamesStringLista de nombres de promociones separada por ',' de las promociones aplicada al producto
item.discountPercentageDoubleDescuento aplicado al producto
item.returnReasonLongId de la razón de devolución del producto


productObjectProducto del pedido
product.idLongIdentificador único del producto
product.codeStringIdentificador único por compañía del producto
product.descriptionStringDescripción completa del producto
product.priceDoublePrecio del producto, incluido impuesto
product.basePriceDoublePrecio base del producto, antes de impuesto
product.quantityDoubleCantidad de inventario en almacén
product.taxObjectImpuesto aplicado al producto, ver detalle más abajo
product.taxOptionalObjectSegundo impuesto aplicado al producto
product.compoundTaxBooleanIndica si los impuestos son compuestos o no
product.enabledBooleanIndica si está habilitado o no
product.barcodeStringCódigo de barras del producto
product.applyDiscountsBooleanIndica si aplica descuento o no
product.pictureUrlStringURL pública de la imagen del producto
product.satProductCodeStringCódigo del producto SAT para facturación en México
product.satUnitCodeStringUnidad del producto SAT para facturación en México
product.minimumPriceDoublePrecio mínimo del producto
product.externalIdStringId externo para emplear en terceros sistema para la sincronización de datos
product.categoryObjectCategoría del producto
product.category.idLongIdentificador único de la categoría del producto
product.category.descriptionStringDescripción de la categoría del producto
product.category.enabledBooleanIndica si está habilitado o no la categoría del producto
product.category.dateCreatedDateTimeFecha de creación
product.category.lastUpdatedDateTimeFecha de la última modificación
product.familyObjectFamilia del producto
product.family.idLongIdentificador único de la categoría del producto
product.family.descriptionStringDescripción de la familia del producto
product.family.enabledBooleanIndica si está habilitado o no la familia del producto

Actualizado el: 10/05/2024

¿Este artículo te resultó útil?

Comparte tu opinión

Cancelar

¡Gracias!