API data dictionary

String text fields where no field length is specified are limited to 255 characters.

Orders (SalesOrder)

Field	Type	Details
id	Long	Order identifier unique code
mobileDateCreated	DateTime	Date and time of creation in the mobile app
dateCreated	DateTime	Date and time when the order reached the backend's database
totalSales	Double	Order total, including taxes
totalTax	Double	Tax total
totalBeforeTax	Double	Order price before taxes
scheduledDateForDelivery	DateTime	Scheduled date for delivery
exported	Boolean	Indicates if the order has been exported to Excel (yes or no)
sellerComment	String (2,000)	Comment made by the salesperson when creating the order
latitude	Double	Latitude of where the order was created (coordinates). Decimal format
longitude	Double	Longitude of where the order was created (coordinates). Decimal format
accuracy	Double	Accuracy of the recorded coordinates (meters)
tookInPlace	Boolean	Indicates if the order was placed in the client's established location (yes or no)
billed	Boolean	Indicates if the order has been billed (yes or no)
billable	Boolean	Indicates if the client wants to bill the order (yes or no)
routeSalePaymentType	String	Payment type ("Cash" or "Credit")
promoIds	String (Longtext)	List of each applied promotion's unique IDs, separated by commas
promoNames	String (Longtext)	List of each applied promotion's name, separated by commas
networkSignalQuality	Integer	Network signal quality at the moment of creating an order in the mobile device (0-5)
creationSource	String	The order's source of creation ("WEB", "MOBILE" , "API" , "IMPORT")
deleted	Boolean	Indicates if the order has been deleted (yes or no)
dateDeleted	DateTime	Date of when the order was deleted
deletedBy	Object	View details in the table below
isEdited	Boolean	Indicates if the order has been edited (yes or no)
editedFrom	Object	If the order has been edited, the parent order is stored
salesType	String	Indicates the order type ("Presale", "Route sale", or "Return")
externalId	String	Reference to third-party systems for synchronization
operativeStatus	String	Order's operative status (PENDING_DELIVERY, ON_ROUTE, PARTIAL_DELIVERED_OPEN, PARTIAL_DELIVERED_CLOSED, DELIVERED_COMPLETE, RETURNED, CANCELLED, CLOSED)
prettyOperativeStatus	String	Order's operative status translated to Spanish ( "Por entregar", "En ruta" , "Entrega parcial", "Entrega completa", "Devuelto", "Cancelado", "Cerrado")
lastDeliveryDate	Datetime	Date of when the order had a successful delivery attempt
lastDeliveryAttempt	Datetime	Date of the order's last delivery attempt, successful or failed
errorMessageFromIntegration	String (Longtext)	Error message in case one exists for third-party system synchronization
deliveredById	Long	Delivery user's ID that completed the delivery associated with an order. It's assigned when the delivery is created
type	Object	View details in the table below
priceList	Object	View details in the table below
createdBy	Object	Salesperson who created the order. User. View details in the table below
deletedBy	Object	View details in the table below
customer	Object	View details in the table below
items	Array	View details in the table below

customer	Object	Order's client
customer .id	Long	Client's unique identifier (ID)
customer.code	String	Client's code
customer.description	String	Client's name
customer.enabled	Boolean	Indicates if the client is enabled (yes or no)
customer.balance	Double	Client's balance
customer.credit	Double	Client's credit limit
customer.address	String	Client's address
customer.postalCode	String	Client's postal code
customer.neighborhood	String	Client's neighborhood
customer.comments	String (2000)	Client's comments
customer.businessName	String	Client's business name
customer.cfdiUse	Object	Client's CFDI use for billing (Mexico)
customer.fiscalRegime	Object	Client's fiscal regime for billing (Mexico)
customer.paymentForms	Object	Payment type
customer.zone	Object	Client's assigned zone
customer.zone. id	Long	Client's assigned zone ID
customer.zone.description	String	Client's assigned zone name
customer.zone.enabled	Boolean	Indicates if the client's assigned zone is enabled (yes or no)
customer.zone.color	String	Hexadecimal color that identifies the client's assigned zone
customer.zone.dateCreated	DateTime	Client's assigned zone date of creation
customer.zone.lastUpdated	DateTime	Client's assigned zone last update
customer.priceList	Object	Client's assigned price list. View details in the table below

type	Object	Order type
type. id	Long	Order's unique identifier number
type.description	String	Order type description
type.enabled	Boolean	Indicates if the order type is enabled (yes or no)
type.dateCreated	DateTime	Date and time of when the order type was created
type.lastUpdated	DateTime	Date and type of the order type's last update

priceList	Object	Price list
priceList. id	Long	Price list's unique identifier
priceList.code	String	Price list's code created by the order
priceList. name	String	Price list's name
priceList.enabled	Boolean	Indicates if the price list is enabled (yes or no)
priceList.dateCreated	DateTime	Price list's date of creation
priceList.lastUpdated	DateTime	Date of the price list's last update

createdBy	Object	User that created the order
createdBy. id	Long	User's unique identifier (ID)
createdBy.username	String	User's username
createdBy. name	String	User's name and last name
createdBy.enabled	Boolean	Indicates if the user is enabled (yes or no)
createdBy.pictureUrl	String	Public URL of the user's profile picture

deletedBy	Object	User that deleted the order
deletedBy. id	Long	User's unique identifier (ID)
deletedBy.username	String	User's username
deletedBy. name	String	User's name and last name
deletedBy.enabled	Boolean	Indicates if the user is enabled (yes or no)
deletedBy.pictureUrl	String	Public URL of the user's profile picture

items	Array	List of items in the order
item. id	Long	Order item's unique identifier (ID)
item.product	Object	Product sold. View details in the table below
item.price	Double	Product price
item.quantity	Double	Quantity sold
item.total	Double	Total= product price * quantity sold
item.tax	Object	Tax applied to the product. View details in the table below
item.taxOptional	Object	Second tax applied to the product (optional)
item.compoundTax	Boolean	Indicated if taxes are compound (yes or no)
item.delivered	Bigdecimal	Indicates how much product was delivered
item.isReturn	Boolean	Indicates if it's a return (yes or no)
item.isReward	Boolean	Indicates if the product was added as part of a promotion (yes or no)
item.promoIds	String	List of promotion IDs applied to products separated by commas ","
item.promoNames	String	List of promotion names applied to products separated by commas ","
item.discountPercentage	Double	Discount percentage applied to products
item.returnReason	Long	ID of the reason for return

product	Object	Order product
product. id	Long	Product's unique identifier (ID)
product.code	String	Company's unique product identifying code
product.description	String	Product's complete description
product.price	Double	Product's price, tax included
product.basePrice	Double	Product's base price, before taxes
product.quantity	Double	Product's quantity in warehouse
product.tax	Object	Tax applied to the product. View details in the table below
product.taxOptional	Object	Second tax applied to the product (optional)
product.compoundTax	Boolean	Indicates if taxes are compound (yes or no)
product.routingWeightLoad	Number	Weight load per unit (Kg)
product.routingWeightVolume	Number	Volume load per unit (centimeters cubed)
product.enabled	Boolean	Indicates if the product is enabled (yes or no)
product.barcode	String	Product's barcode
product.applyDiscounts	Boolean	Indicates if the product has applied discounts (yes or no)
product.pictureUrl	String	Public URL of the product's picture
product.satProductCode	String	Product's SAT code for billing (Mexico)
product.satUnitCode	String	Product's SAT unit code for billing (Mexico)
product.minimumPrice	Double	Product's minimum price
product.externalId	String	External ID to use for third-party system synchronization
product.category	Object	Product's category
product.category. id	Long	Product category's unique identifier (ID)
product.category.description	String	Product category's description
product.category.enabled	Boolean	Indicates if the product category is enabled (yes or no)
product.category.dateCreated	DateTime	Product category's date of creation
product.category.lastUpdated	DateTime	Product category's last update
product.family	Object	Product family
product.family. id	Long	Product family's unique identifier (ID)
product.family.description	String	Product family's description
product.family.enabled	Boolean	Indicates if the product family is enabled (yes or no)

Updated on: 01/30/2026

Was this article helpful?

Thank you!