This doc page has moved! You should be automatically redirected to the resources page for the eBay Fulfillment API. If you are not redirected automatically, follow this link to the Fulfillment API.

eBay Fulfillment APIVersion 1.2.0

Order

This type contains the details of an order, including information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status.

Type that uses Order:

Calls that use Order:

Fields



buyer ( Buyer ) [0..?]
Contains information about the buyer who paid the order.
See the Field Index to learn which calls use buyer.

buyerCheckoutNotes ( string ) [0..?]
Comments about the order (if any) provided by the buyer at checkout.
See the Field Index to learn which calls use buyerCheckoutNotes.

cancelStatus ( CancelStatus ) [0..?]
Contains information about a request (if any) that has been made to cancel the order.
See the Field Index to learn which calls use cancelStatus.

creationDate ( string ) [0..?]
The date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
See the Field Index to learn which calls use creationDate.

fulfillmentHrefs ( array of string ) [0..?]
Contains a list of one or more hypertext references in the form of URLs. Each URL can be used to invoke the Get Shipping Fulfillment call to retrieve the details of each fulfillment, if any, that is associated with this order.
See the Field Index to learn which calls use fulfillmentHrefs.

fulfillmentStartInstructions ( array of FulfillmentStartInstruction ) [0..?]
Contains a list of one or more sets of specifications for fulfilling the order. Each set specifies the type of fulfillment, shipping carrier and service, addressing details, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections. The seller can use them as a starting point for packaging, addressing, and shipping the order.
See the Field Index to learn which calls use fulfillmentStartInstructions.

lastModifiedDate ( string ) [0..?]
The date and time that the order was last modified.This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
See the Field Index to learn which calls use lastModifiedDate.

lineItems ( array of LineItem ) [0..?]
Contains the details of one or more line items that comprise the order. A line item consists of one or more units of a specific variation and version of a listed item that has been purchased.
See the Field Index to learn which calls use lineItems.

orderFulfillmentStatus ( OrderFulfillmentStatus ) [0..?]
The degree to which fulfillment of the order is complete.
See the Field Index to learn which calls use orderFulfillmentStatus.

orderId ( string ) [0..?]
The unique identifier of the order. This value was originally generated by eBay as a result of the buyer's checkout process; for example, 170009092860-9849164007!140000000544476.

Note: The value of this field is not formatted the same way as the value of the Trading API's OrderId field. Do not attempt to use this field's value in the Trading API.
See the Field Index to learn which calls use orderId.

orderPaymentStatus ( OrderPaymentStatusEnum ) [0..?]
The current status of all monetary exchanges (payment by buyer and refund to buyer) for the order.
See the Field Index to learn which calls use orderPaymentStatus.

paymentSummary ( PaymentSummary ) [0..?]
Contains information about the various monetary exchanges for the order.
See the Field Index to learn which calls use paymentSummary.

pricingSummary ( PricingSummary ) [0..?]
Contains a summary of costs and charges for the order, including price, adjustment, taxes, and shipping.
See the Field Index to learn which calls use pricingSummary.

sellerId ( string ) [0..?]
The eBay ID of the seller who sold the order.
See the Field Index to learn which calls use sellerId.