Order Object

The order object represents order data you can send to Bronto. The Order Service provides REST APIs for interacting with carts and orders.

Overview

Contains the REST Order object.

Parameters


Name	Type	Comments
`orderId`	string	The Bronto ID for the order provided by Bronto. universally unique identifier (UUID)
`customerOrderId`	string	The order ID from your commerce system. 255 characters
`orderDate`	date	The date and time the order was placed. ISO 8601 time format (Example: `2019-11-02T18:47:57+00:00`) Note: The enhanced order attribution model uses the value of orderDate as part of the conversion calculation process. To avoid issues with conversion tracking, ensure that you include a value for the UTC offset (`+00:00`).
`cartId`	string	The ID provided by Bronto when using the Cart API. universally unique identifier (UUID)
`emailAddress`	string	The email address of the customer placing the order. Validly formatted email address
`currency`	string	The currency code for the order. You can only have one currency code per order. ISO 4217 currency format (Example: `USD`)
`subtotal`	number	The subtotal from your commerce system before shipping, tax, and discount amounts are applied. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`taxAmount`	number	The tax amount associated with your order from your commerce system. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`discountAmount`	number	The discount amount associated with your order from your commerce system. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`shippingAmount`	number	The shipping amount associated with your order from your commerce system. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`grandTotal`	number	The grand total from your commerce system, after shipping, tax, and discount amounts are applied. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`shippingDate`	date	The date the order did or will ship. ISO 8601 time format (Example: `2019-11-02T18:47:57+00:00`)
`shippingDetails`	string	Information associated with a shipment. 10,000 characters maximum
`shippingTrackingURL`	string	The FedEx, UPS, or other mail service URL associated with a shipment. 4,096 characters maximum
`originIp`	string	The IP address of the browser Valid IPv4 or IPv6 value
`originUserAgent`	string	The user agent for the browser. 1,023 characters
`tid`	string	A unique cookie identifier that associates an order with a specific contact and delivery. Used to associate a contact and email delivery in conversion reporting. Bronto does not store the `tid`.
`trackingCookieName`	string	Name of Bronto-provided cookie for attribution.
`trackingCookieValue`	string	A unique cookie identifier that associates an order with a specific contact and delivery. Used to associate a contact and email delivery in conversion reporting. Bronto will store the `trackingCookieName` and `trackingCookieValue` in addition to the field values.
`Status`	string	The status of the order. The status lets you know if the order has been processed or not, which can be helpful if there is a concern about the status of a customer's order.Only processed orders will appear in the application. `PENDING` or `PROCESSED`
`orderSource`	string	Indicates where an order originated. Valid values are `WEBSITE`, `INSTORE_POS`, `CALL_CENTER`, `CUSTOM1`, `CUSTOM2`, and `CUSTOM3`. You can not modify the values `CUSTOM1`, `CUSTOM2`, and `CUSTOM3`. You can include the `orderSource` field with no value. The enhanced order attribution model currently only considers orders where the Source field is equal to `WEBSITE`.
`mobileNumber`	string	The mobile number included on the order. The number must use E.164 format. (Example: `19195551212`)
`smsOrderConsent`	boolean	The box contacts can check if they want to receive order-based SMS messages for that particular transaction. `true` or `false`
`states`: {
`processed`	boolean	Indicates whether the order has been processed and can be used in workflows. `true` or `false`
`shipped`	boolean	Indicates whether the order has been shipped and can be used in workflows. `true` or `false`
}
`lineItems`: [
`name`	string	The name of the line item. 200 characters
`description`	string	A description of the line item. 10,000 characters
`sku`	string	The SKU for the item. It should match your product catalog and use the same capitalization. 100 characters
`category`	string	The category of the line item. 1,000 characters
`other`	string	Additional information about the line item. 2,500 characters
`imageURL`	string	The URL path to an image of the line item. 20,000 characters
`productURL`	string	The URL path to the product in your commerce system. 2,000 characters
`quantity`	number	The quantity purchased of a specific line item. This field cannot be null. No more than 6 decimal places, maximum value is 999,999,999.999999
`salesPrice`	number	If the product is on sale, the sales price for the product.If the product is not on sale, the sale price will match the unit price. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`totalPrice`	number	Price for an individual product in the order without shipping or tax included. This field cannot be null. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`unitPrice`	number	Normal price for the product. No more than 6 decimal places, maximum value is 999,999,999.999999 All currency amounts are numbers with a period as a decimal separator. The total `1234.56` is valid and `1.234,56` is not valid.
`position`	number	The order of the line item in `lineItems[]`. 2,500 characters
]

Example Order Object

 {
    "cartId": 3eaf0abf-e018-4433-a4bb-7010aac2610z,
    "contactId": "0d0f59cf-9293-4ed4-b585-28a7b9bedbfe",
    "createdDate": "2017-03-23T16:11:22.187Z",
    "currency": "USD",
    "customerOrderId": "100000889",
    "deliveryId": null,
    "discountAmount": 0,
    "emailAddress": "example@example.com",
    "grandTotal": 16.5,
    "lineItems": [
        {
            "category": "Delta Apparel",
            "description": "Mix it up with this durable 65% polyester/25% cotton twill apron. Available in one size and one color. The adjustable neck strap and reinforced waist ties will ensure a great fit. Bon appetit!",
            "imageUrl": null,
            "name": "Bronto Apron",
            "other": null,
            "position": 0,
            "productUrl": "http://brontogear.com/apron.html",
            "quantity": 1,
            "salePrice": 11.25,
            "sku": "6",
            "totalPrice": 15,
            "unitPrice": 15
        },
        {
            "category": "Delta Apparel",
            "description": "Go green in more ways than one in this 100% certified organic cotton tee.",
            "imageUrl": null,
            "name": "Toddler Tee",
            "other": null,
            "position": 1,
            "productUrl": "http://brontogear.com/toddler-tee.html",
            "quantity": 1,
            "salePrice": 9,
            "sku": "401",
            "totalPrice": 12,
            "unitPrice": 12
        },
        {
            "category": "Delta Apparel",
            "description": "You asked. We answered.",
            "imageUrl": null,
            "name": "Women's Tee",
            "other": null,
            "position": 2,
            "productUrl": "http://brontogear.com/women-s-bronto-t-shirt.html",
            "quantity": 1,
            "salePrice": 11.25,
            "sku": "10",
            "totalPrice": 22.95,
            "unitPrice": 22.95
        }
    ],
    "messageId": null,
    "mobileNumber": "19195551212",
    "orderDate": "2018-12-01T00:00:00.000Z",
    "orderId": "ea1eddc2-7d94-4af5-bd7c-b4cb3781a658",
    "originIp": "10.0.0.1",
    "originUserAgent": "Chrome OS",
    "shippingAmount": null,
    "shippingDate": null,
    "shippingDetails": null,
    "shippingTrackingUrl": null,
    "smsOrderConsent": true,
    "status": "PROCESSED",
    "subtotal": 16.5,
    "taxAmount": 1.5,
    "trackingCookieName": null,
    "trackingCookieValue": null,
    "updatedDate": "2017-03-23T16:11:22.187Z",
    "states": {
        "processed": true,
        "shipped": true
    },
    "hasTracking": false
}