eBay Trading APIVersion 1119

OrderStatusCodeType ( token )

Enumerated type that defines the possible values for order states. Some of these values can be used as OrderStatus filters in the GetOrders request payload, and some of these values may be returned in any of the order management calls under the OrderStatus field. See the individual value descriptions for more information on how they are used and/or when they are returned.

Types that use OrderStatusCodeType:

Calls that use one or more values of OrderStatusCodeType:

Enumeration Values

Value Description
Active This value indicates that the order is not yet complete. An order in the Active state means that the buyer has not initiated payment for the order. While an order is in this state, it can be combined into a Combined Invoice, a buyer can request a cancellation, and/or a seller can update payment details (including a change in order price) or shipping details (including shipping cost and shipping service).

This value can be used a filter value in the OrderStatus field of the GetOrders request payload, and it can also be returned in any of the order management calls.
All This enumeration value is passed into the OrderStatus of GetOrders to retrieve orders in all states. This is the default value. This value is not applicable to the response payloads of the order management calls.
Cancelled This value indicates that the order has been cancelled. Depending on whether payment was made or not, the seller may also need to refund the buyer after an order is cancelled.

This value can be used a filter value in the OrderStatus field of the GetOrders request payload, and it can also be returned in any of the order management calls.
CancelPending This value indicates that a buyer has initiated a cancellation request on the order. If a seller sees an order in this state, that seller must either approve or reject the cancellation request through My eBay Web flows or through the Post-Order API cancellation calls.

This enumeration value cannot be used as an OrderStatus value in the GetOrders request payload.
Completed This value indicates that the order is paid for and complete. An order in the Completed state means that no other changes to the order can be made.

This value can be used a filter value in the OrderStatus field of the GetOrders request payload, and it can also be returned in any of the order management calls.
CustomCode Reserved for internal or future use.
Inactive This value can be used a filter value in the OrderStatus field, and if used, all inactive orders will be returned.
InProcess This enumeration value indicates that the order is currently in the state of being processed, but is not yet complete.

This value is not supported by the OrderStatus field of the GetOrders request payload, but it can be returned in any of the order management calls.
  * See the Enumeration Index to see exact use of each enumeration value in the API.