OrderResponseItem

Overview

This object contains the results of the GetOrderList call. . The amount of data returned in this item is dependent on the DetailLevel field in the OrderCriteria object: Low, Medium, High or Complete.

Detail Level

Description

Low

Will return an OrderResponseDetailLow object which inherits from OrderResponseItem.

Medium

Will return an OrderResponseDetailMedium object which inherits from OrderResponseDetailLow.

High

Will return an OrderResponseDetailHigh object which inherits from OrderReseponseDetailMedium.

Complete

Will return an OrderResponseDetailComplete object which inherits from OrderResponseDetailHigh.

Fields

Field Name

Detail Level

Data Type

Description

NumberOfMatches

Low

int

Total number of orders in the result set.

OrderTimeGMT

Low

dateTime

GMT timestamp representing when the order was created

LastUpdateDate

Low

dateTime

GMT timestamp representing the last time the order was updated

TotalOrderAmount

Low

decimal

Total amount charged to the buyer

OrderState

Low

OrderStateCode

Contains an enumerated string of one of the following values:

  • Active
  • Archive
  • Cancelled
    Note: This is a legacy field that is not a good indicator of whether or not an order has been canceled.

DateCancelledGMT

Low

dateTime

GMT timestamp representing when the order was cancelled

OrderID

Low

int

This is the ChannelAdvisor identifier for the order record.  This value is used to identify the order in a number of API calls in Order Service and Shipping Service.

ClientOrderIdentifier

Low

string

Up to 125 characters.  This is usually the marketplace's identifier for the order and is displayed in the ChannelAdvisor UI to identify the order.

SellerOrderID

Low

string

A custom order identifier defined by the client.

FlagStyle

Low

FlagType

Marks the order with a flag

OrderStatus

Low

OrderStatus

Represents the current state of the order

ResellerID

Medium

int

BuyerEmailAddress

Medium

string

Up to 255 characters

EmailOptIn

Medium

boolean

PaymentInfo

Medium

PaymentInfoResponse

Payment information

ShippingInfo

Medium

ShippingInfoResponse

Shipping address, requested shipping method, and other relevant information

BillingInfo

Medium

BillingInfo

Billing address and other relevant information

FlagDescription

Medium

string

Up to 80 characters.  A note that can accompany a flag.

ShoppingCart

High

OrderCart

Contains information on the items purchased by a buyer.

CustomValueList

Complete

CustomValue[]

List of custom fields collected during the ChannelAdvisor Checkout process.

BuyerIpAddress

Complete

string

Buyer's IP address collected during the ChannelAdvisor Checkout process.

TransactionNotes

Complete

string

Up to 1000 characters

References