EBAY ORDERS API

adminComment(0)
    Contents:

Single line item orders: In the API, a Transaction object, including a TransactionID and an OrderLineItemID, is generated by site as soon as the downloader commits. The Order API is part of the site download APIs. It is used to download items and track the download orders. The Order API supports the complete checkout process. Use this call to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter.


site Orders Api

Author:LOUELLA KLUENDER
Language:English, Arabic, French
Country:Latvia
Genre:Children & Youth
Pages:544
Published (Last):17.12.2015
ISBN:846-7-56140-166-4
ePub File Size:22.79 MB
PDF File Size:12.24 MB
Distribution:Free* [*Registration needed]
Downloads:36391
Uploaded by: SHERLY

The Order API supports both site guest and site member (signed in) checkouts . A guest checkout is where someone does not sign into the site site and you. This container consists of information about the order's downloader. At this time, only the downloader's site user ID is returned, but it's possible that more downloader information . site: apis:eBLBaseComponents"> Order> OrderType.

This field is applicable to Flat and Calculated shipping. ShipToLocation string Conditional, repeatable: ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified. If using a Trading WSDL older than Version , ShipToLocation fields are only returned to the downloader or seller, and a string value of Unavailable will be returned to all third parties. Additionally, it indicates whether or not the seller applies sales tax to shipping charges in addition to the item cost.

A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions. This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item. Beginning January 1, , downloaders in some US states will automatically be charged sales tax for site downloads.

So, if a sales tax rate is established for a state that is subject to 'site Collect and Remit', this sales tax rate will be ignored by site during checkout process. For a list of the US states that will become subject to 'site Collect and Remit' and effective dates , see the site sales tax collection help topic. SalesTaxPercent float Optional This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction US state or Canadian province.

Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a downloader from that tax jurisdiction makes a download from the seller. The value passed in is stored with a precision of 3 digits after the decimal point. This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem and other 'Get' calls if sales tax is applicable to the listing or order line item, and the seller is the person making the call.

As of January 1, , downloaders in some US states will automatically be charged sales tax for site downloads. So, if a sales tax rate is established for a state that is subject to 'site Collect and Remit', the sales tax rate in this field is ignored by site during checkout process. For a list of US states that will become subject to 'site Collect and Remit' and effective dates , see the site sales tax collection help topic.

This value defaults to false if not specified. This field is always returned with the SalesTax container whether true or false. So, if a true value is set for this field for a state that is subject to 'site Collect and Remit', this setting is ignored by site during checkout process. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item.

Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous.

For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: ShippingService token Conditional This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a downloader who is located within the same country as the item.

Type that uses Order

This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container. To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails. ShippingService fields.

ShippingServiceCost AmountType double Conditional The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the downloader downloads multiple quantity of the same line item.

Also, if a shipping service has been specified even LocalPickup , GetItem returns the shipping service cost, even if the cost is zero. ShippingServicePriority int Conditional Controls the order relative to other shipping services in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services with four ShippingServiceOptions containers , so valid values are 1, 2, 3, and 4.

Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options. Only returned if set.

If some line items in an order have a surcharge, surcharge is added only for those line items. Total AmountType double Required The Total amount shows the total cost for the order, including total item cost shown in Subtotal field , shipping charges shown in ShippingServiceSelected. ShippingServiceCost field , and sales tax shown in SalesTax. SalesTaxAmount field.

In an AddOrder call, the seller can pass in the Total amount for the 'Combined Invoice' order, and this is what the downloader will be expected to pay for the order.

For a list of possible enumeration values, see CurrencyCodeType. The data for each order line item in the order is stored in a separate Transaction container. Under the TransactionArray container in an AddOrder call, a seller or downloader specifies two or more up to 40 order line items into a 'Combined Invoice' order. Transaction TransactionType Required, repeatable: This container consists of detailed information on one order line item.

For the AddOrder call, a Transaction container is used to identified the unpaid order line items that are being combined into one Combined Invoice order.

Item ItemType Required This container consists of relevant details about the listing associated with the order line item. Which listing fields are returned under this container will depend on the listing, the site marketplace, and the API call.

In an AddOrder call, only the unique identifier of the listing ItemID is needed to help identify the order line item to combine into a 'Combined Invoice' order. This identifier is generated by site and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. Although we represent item IDs as strings in the schema, we recommend you store them as bit signed integers.

If you choose to store item IDs as strings, allocate at least 19 characters assuming decimal digits are used to hold them. Your code should be prepared to handle IDs of up to 19 digits. Below are some examples from different countries. If the same InvocationID is passed in after it has been passed in once on a call that succeeded for a particular application and user, then an error will be returned.

All API documentation

The identifier can only contain digits from and letters from A-F. The identifier must be 32 characters long. Max length: Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data with no filters.

However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data not cached. The version you specify for a call has these basic effects: It indicates the version of the code lists and other data that site should use to process your request.

It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. Specify the version of the WSDL your application is using. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. High in The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request.

Setting the WarningLevel value to High is not recommended in a production environment. Low in The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level. This value is only created and returned if the AddOrder call is successful in creating the new order. This value can be used as an input filter in GetOrders and GetOrderTransactions calls to retrieve the order.

Starting in June , site will start changing the format of order identifier values. The new format will be a non-parsable string, globally unique across all site marketplaces, and consistent for both single line item and multiple line item orders. For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers e.

Because we realize that some integrations may have logic that is dependent upon the identifier format, site is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely. The compatibility version is expected to be Version During the transition period and even after, the new and old OrderID formats will still be supported in all Trading API call request payloads.

After the transition period which will be announced , only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.

The AckCodeType list specifies the possible values for the Ack field. CustomCode out Reserved for internal or future use. Failure out This value indicates that the call request processing failed. Success out This value indicates that the call request was processed successfully without any issues. Warning out This value indicates that the call request was successful, but processing was not without any issues.

These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request. Not all values in AckCodeType apply to this field.

Code so that your app gracefully handles any future changes to this list. Build string Always This refers to the specific software build that site used when processing the request and generating the response.

This includes the version number plus additional information. Errors ErrorType Conditionally, repeatable: RequestError out An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data or missing data. In these cases, do not retry the request.

Order API Overview

The problem must be corrected before the request can be made again. If the problem is due to something in the application such as a missing required field , the application must be changed.

If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to site with the corrected data.

SystemError out Indicates that an error has occurred on the site system side, such as a database or server down. An application can retry the request as-is a reasonable number of times site recommends twice. If the error persists, contact Developer Technical Support.

Once the problem has been resolved, the request may be resent in its original form. ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. These are useful when multiple instances of ErrorType are returned.

Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. LongMessage string Conditionally A more detailed description of the condition that raised the error.

SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error causing the request to fail or an informational error a warning that should be communicated to the user. Error out The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. If the source of the problem is within the application such as a missing required element , change the application before you retry the request.

If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to site. If the source of the problem is on site's side, An application can retry the request as-is a reasonable number of times site recommends twice.

Warning out The request was processed successfully, but something occurred that may affect your application or the user. For example, site may have changed a value the user sent in. In this case, site returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request as the original request was successful. However, depending on the cause or nature of the warning, you might need to contact either the end user or site to effect a long term solution to the problem to prevent it from reoccurring in the future.

ShortMessage string Conditionally A brief description of the condition that raised the error. HardExpirationWarning string Conditionally Expiration date of the user's authentication token.

Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time set by site. After this amount of time has passed, the token expires and must be replaced with a new token. Timestamp dateTime Always This value represents the date and time when site processed the request.

GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. When this occurs, this time value does reflect when the request was processed.

Version string Always The version of the response payload schema. Indicates the version of the schema that site used to process the request. See the Standard Data for All Calls section in the site Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. Basic Call. Call-specific Input Fields [Jump to standard fields].

You might also like: BROJSOVA TERAPIJA PDF

The root container of the AddOrder request. Conditional, repeatable: A PaymentMethods field will appear for each payment method available to the downloader for the order's download. The email address of the seller involved in the order. Container consisting of order-level shipping details.

AmountType double. This dollar value indicates the money due from the downloader upon delivery of the item. Optional, repeatable: Shipping costs and options related to an international shipping service. An international shipping service being offered by the seller to ship an item to a downloader. See ShippingServiceCodeType.

The cost of shipping each additional item if the same downloader downloads multiple quantity of the same line item. The base cost of shipping the item using the shipping service specified in the ShippingService field.

This integer value controls the order relative to other shipping services in which the corresponding ShippingService will appear in the View Item and Checkout page. An international location or region to where the item seller will ship the item. This container shows the sales tax rate percentage for a specific tax jurisdiction. This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction US state or Canadian province.

This is the unique, two-digit identifier of the tax jurisdiction such as 'CA' for California. This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service.

This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a downloader who is located within the same country as the item. The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. Controls the order relative to other shipping services in which the corresponding ShippingService will appear in the View Item and Checkout page.

The Total amount shows the total cost for the order, including total item cost shown in Subtotal field , shipping charges shown in ShippingServiceSelected. Container consisting of one or more line items that comprise an order. Required, repeatable: A Transaction container is returned for each line item in the order.

This container consists of relevant details about the listing associated with the order line item. ItemIDType string. The unique identifier of the site listing. Unique identifier for an site order line item. Selling Integration Guide: How to use site APIs to help professional sellers add their inventory and grow their business on site. These APIs are for eligible developers only. Turnkey solution for creating downloading experiences in your app or website.

Retrieve purchasable items, check out, then track orders without visiting the site site. downloading Integration Guide: How to use site APIs to create great downloading applications. Find use cases; learn workflows. We recommend you integrate with the new, updated API when it becomes available.

The Large Merchant Services documentation is still available for anyone who has already integrated. We recommend you integrate with the Marketing API for managing sales promotions for seller inventory. Manage cancellations, returns, and disputes, as well as provide communication between downloaders and sellers. For details of what is requried and how to apply, see download APIs Requirements Turnkey solution for creating downloading experiences in your app or website.

Search site; build search and browse experiences.The checkout functionality is described below:. The date of the shipment tracking event. Conditional appliedCoupons.

Conditional warnings array of ErrorDetailV3 An array of warning messages.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers e. For more on errors, plus the codes of other common errors, see Handling errors.