Order structure

The structure of the generated order is a standardized format that describes all relevant information related to a purchase. It is made up of different fields that provide details about the order, such as unique identifiers, update type, customer information, delivery address, order items, and payment information. Each field plays an important role in order representation and processing, allowing e-commerce systems to efficiently understand and process orders.

objectId: This field contains the unique ID of the order.

eventType: Indicates the request update type. It can have the value "ORDER_UPDATE" when the entire structure of the order is sent or "ITEM_UPDATE" when only the list of items is sent.

retailerOrderId: This field contains a sequential ID of the order used by the store.

isInternational: Indicates whether the order is international or not. It can have the value true if it is international or false if it is domestic.

canAcceptBoleto: Indicates whether the order can be paid by bank slip. It can have the value true if bank slip is accepted or false otherwise.

canAcceptCreditCard: Indicates whether the order can be paid by credit card. It can have the value true if credit card is accepted or false otherwise.

discount: This field indicates the amount of the discount applied to the order.

discountMode: Indicates the discount mode applied to the order. It can be "ABSOLUTE" if the discount is an absolute amount or "PERCENTAGE" if it is a percentage amount.

deliveryTime: Indicates the estimated delivery time of the order.

shippingMethod: Indicates the order shipping method, such as "SEDEX".

freightCost: This field contains the freight cost of the order.

freeShipping: Indicates whether shipping is free for the order. It can have the value true if the shipping is free or false otherwise.

paymentAccountSelected: This field contains the ID of the payment account selected to process payment for the order. It can be the ID of a payment platform such as Mundipagg, Moip, Adyen, etc.

orderAccountSelected: This field contains the account ID of the store selected to process the order. It can be the ID of an e-commerce platform, such as VTEX, Ciashop, etc.

customer: This object contains information about the customer who placed the order, such as first name, last name, gender, CPF, e-mail, telephone, etc.

shippingAddress: This object contains information about the delivery address of the order, such as street, complement, zip code, city, state and country.

items: This array contains the order items. Each item is represented by an object that contains information such as item ID, quantity, price, product reference, weight, height, width, length and variant ID (if any)