Orders: Order object


Attributes available on an Order object.

Attribute Details
id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is message.

additional_information
hash

An object that contains the form field data that was submitted on the "Additional Information" step of ecommerce checkout.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is form_submission_field.

field_type
string

The type of form field this data was submitted from (e.g., text, checkboxes, email, name).

formatted_value
string

The submitted value formatted as a string.

label
string

The form field label.

values
hash

The values submitted for this field. The attributes available in the hash will depend on the field type. For example, a "text" field will only have a submitted_value attribute, but a "name" field will have prefix, first, middle, last, and suffix.

amount_paid
integer

Amount that has been paid, in cents.

billing_address
hash

An object that contains the form field data that was submitted on the "Billing Information" step of ecommerce checkout.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is form_submission_field.

field_type
string

The type of form field this data was submitted from (e.g., text, checkboxes, email, name).

formatted_value
string

The submitted value formatted as a string.

label
string

The form field label.

values
hash

The values submitted for this field. The attributes available in the hash will depend on the field type. For example, a "text" field will only have a submitted_value attribute, but a "name" field will have prefix, first, middle, last, and suffix.

content_catalog
integer

The ID of the content catalog the order was placed from.

currency
string

Three-letter ISO currency code.

date_created
date_time

Date the object was created. The date is returned in the ISO-8061 format.

is_pay_later
boolean

Value will be true if the customer who placed the order opted to pay at a later time. If the customer has paid for the order the value will be false.

items
list

A list of catalog items that were added to the order.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Possible values are order_item, versadoc_order_item, or design_ready_order_item.

attributes
hash

An object that contains attribute values that were submitted for this item.

Includable

catalog_item
integer

The ID of the catalog item this item was ordered from.

content_catalog
integer

The ID of the content catalog the item was from.

date_created
date_time

Date the object was created. The date is returned in the ISO-8061 format.

description
string

The catalog item's description.

exempt_from_shipping
boolean

Whether or not the catalog item is exempt from shipping charges.

is_taxable
boolean

Whether or not the item is taxable.

portal
integer, hash

ID of the portal the item was ordered from. If expanded the field will be a hash describing the portal.

Includable

pricing
hash

Object describing the pricing for this item. The object includes the unit price in cents, the volume unit price in cents, and the item subtotal in cents.

print_ready_files
list

A list of print ready files that are available for this item. This field is only available if the object type is versadoc_order_item.

Includable

quantity
integer

The number of units of this item that were ordered.

shipment
integer

The ID of the shipment this item belongs to.

short_description
string

The catalog item's short description.

sku
string

The catalog item's item number or SKU.

status
string

The status of the item. Available statuses are pending, ordered, and denied.

tax_class
string

The ID of the tax class the catalog item is assigned to.

tax_percentage
decimal

The tax percentage that was applied for this item.

title
string

The catalog item's title.

versadoc_order_form
hash

An object that contains the variable data that was submitted as part of the VersaDoc item. This field is only available if the object type is versadoc_order_item.

weight
decimal

The catalog item's weight.

message
integer, message object

The ID of the message that is associated with the order. If expanded the field will be a message object.

Includable

notes
list

A list of notes that have been added to the order.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is order_note.

date_created
date_time

Date the object was created. The date is returned in the ISO-8061 format.

note
string

The content of the note.

user
hash

An object describing the account user who added the note.

order_type
string

The type of order. Possible values are catalog or ecommerce.

payment_transactions
list

A list of payments made for this order.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is payment_transaction.

amount
integer

The amount of the payment, in cents.

currency
string

Three-letter ISO currency code.

date_created
date_time

Date the object was created. The date is returned in the ISO-8061 format.

is_recurring
string

Indicates whether or not this is a recurring payment.

payment_type
string

How the payment was made. Possible values are ach, credit_card, and manual.

test_mode
boolean

Indicates whether the payment was made in test mode.

transaction_id
string

Unique identifier for this payment that was generated by the payment processor.

transaction_status
string

Status of the transaction. Possible values are authorized, captured, and voided.

transaction_type
string

The type of payment transaction. Possible values are payment and credit.

portal
integer, hash

The ID of the portal the order was placed from. If expanded the field will be a hash describing the portal.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is portal.

title
string

The portal's title.

pricing
hash

Object containing pricing information for the order.

object
string

String representing the object's type. Objects of the same type share the same value. Value is order_pricing.

shipping
integer

The cost of shipping for the order, in cents.

shipping_discount
integer

The amount to discount from the shipping cost, in cents.

subtotal
integer

The order subtotal, in cents.

subtotal_discount
integer

The amount to discount from the order subtotal, in cents.

tax
integer

The amount of tax for the order, in cents.

total
integer

The order total, in cents.

promo_code
integer, hash

The ID of the promo code that was applied to the order. If expanded the field will be a hash describing the promo code.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is order_promo_code.

promo_code
hash

An object containing details about the promo code that was applied to the order. The object includes the ID of the promo code, and the promo code string.

shipping_discount
integer

The amount to discount shipping, in cents.

subtotal_discount
integer

The amount to discount the order subtotal, in cents.

shipments
list

A list of shipments for this order.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is order_shipment.

date_created
date_time

Date the object was created. The date is returned in the ISO-8061 format.

date_shipped
date_time

Date the shipment was shipped. The date is returned in the ISO-8061 format.

price
integer

Cost of shipping for this shipment, in cents.

shipping_address
hash

An object that contains the form field data that was submitted on the "Shipping Information" step of ecommerce checkout.

Includable

shipping_carrier
integer, hash

The ID of the shipping carrier. If expanded the field will be a hash describing the shipping carrier. The object will include the shipping carrier ID, carrier type, and title.

Includable

shipping_method
integer, hash

The ID of the shipping method. If expanded the field will be a hash describing the shipping method. The object will include the shipping method ID and title.

Includable

shipping_notification_sent
boolean

Whether or not the shipping notification has been sent.

status
string

Status of the shipment. Possible values are customer_quote, new, and shipped.

tracking_number
string

Tracking number for the shipment from the shipping carrier.

shipping_tax_percentage
decimal

The tax percentage that was applied to the shipping cost.

status
string

The status of the order. Available values are pending_approval, new, denied, processing, canceled, backordered, shipped, and completed.

user
integer, hash

The ID of the user who placed the order. If expanded the field will be a hash describing the user.

Includable

id
integer

Unique identifier for the object.

object
string

String representing the object's type. Objects of the same type share the same value. Value is website_user.

third_party_identifier
string

A custom field that can be used to tie this user to a user in an external system.

username
string

The user's username.