Details about the order data


Field NameTypeRequiredDetails
id
Numberread only
Internal Omnivore identifier for the order. 




marketplace_code
Stringno
The code for the Marketplace. Possible values here (todo)
order_numberStringyesThe order number as created in the Marketplace. This is usually the handle for the orders
alt_order_numberStringnoAn alternate order number in the Marketplace. Some marketplaces (eg eBay) are using different values depending on where the information is displayed. 
retailer_order_idNumbernoWhen the order is created in the retailer system, this field can contain the order identifier from that system. (usually the database table id)
retailer_order_numberStringnoWhen the order is created in the retailer system, this field can contain the order number from that system. Most Omnivore integrations will get this value from the retailer system in te process of creating the order.
statusStringrequired for update
The status of the order in Omnivore.
Todo values
total_pricePrice objectrequired for createThe total value of the order, including shipping but excluding additional fees and taxes that are charged by the Marketplace to the buyer
additional_feeMoney object
noSome Marketplaces will charge an extra fee
additional_taxMoney
noSome Marketplaces (eg eBay) will charge the buyer an extra tax depending on their location. 
customer first_nameStringyes
customer last_nameStringyes
customer emailString no

shipping_addressAddressyesRequired for the create order method. Raed-only afterwards.
billing_addressAddressnoWhen not provided, the shipping_address data is copied into this field
shipping pricePriceyesThis is required when the order is created
shipping carrierStringnoThis can be optionally set when the order status is set to "shipped"
shipping methodStringyes
A values set by the marketplace
shipping tracking_codeString noThis can be optionally set when the order status is set to "shipped"
line_itemsLIst of Line Item objectsyesAt least one line item must be provided in an order
transactionsList of Money objectsyesA list of transactions between the Marketplace and the buyer. For most orders that are valid, not cancelled or refunded, there is a single transaction that reflects the amount paid by the buyer and the respective currency, usually the currency of the marketplace. 
customer_messageString noAlso called "customer checkout message", it's a free text field where the buyer can provide additional info to facilitate order delivery.
createdDatetimeread onlyThe date and time when the order was created in Omnivore
updatedDatetimeread onlyThe date and time when the order was updated in Omnivore
created_in_marketplaceDatetimerequired for createThe date and time when the order was created in the Marketplace.
Address
first_nameStringyes

last_nameStringyes

line1Stringyes

line2Stringno
cityStringyes

stateStringyes

postcodeStringyes
phoneStringno
country_nameStringno
country_codeStringyes2 letter country code, as per https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
Line Item
idNumberread-onlyOmnivore internal line item identfier
product_skuStringread-only
The retailer sku of the product. This value is set by Omnivore by decoding the marketplace sku
variant_skuStringread-only
The retailer sku of the variant. This value is set by Omnivore by decoding the marketplace sku
marketplace_skuStringyesThe sku value of the item as known in the marketplace.
nameStringnoThe name of the product. 
unit_pricePriceyesThe price of a unit as sold in the Marketplace. 
quantityNumberyesHow many units of the item were sold.