{
"openapi": "3.0.0",
"info": {
"title": "Order API",
"description": "Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.
Note: This is a (Limited Release) API available only to select developers approved by business units.
The Order API provides interfaces that let shoppers pay for items. It also returns payment and shipping status of the order.",
"contact": {
"name": "eBay Inc,"
},
"license": {
"name": "eBay API License Agreement",
"url": "https://go.developer.ebay.com/api-license-agreement"
},
"version": "v2.1.2"
},
"servers": [
{
"url": "https://apix.ebay.com{basePath}",
"description": "Production",
"variables": {
"basePath": {
"default": "/buy/order/v2"
}
}
},
{
"url": "https://api.ebay.com{basePath}",
"description": "Production",
"variables": {
"basePath": {
"default": "/buy/order/v2"
}
}
}
],
"paths": {
"/guest_checkout_session/{checkoutSessionId}/apply_coupon": {
"post": {
"tags": [
"guest_checkout_session"
],
"description": "Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.
Important! (Limited Release) This method is only available to select developers approved by business units.
Important! (Limited Release) This method is only available to select developers approved by business units.
Important! (Limited Release) This method is only available to select developers approved by business units.
Important! (Limited Release) This method is only available to select developers approved by business units.
Important! (Limited Release) This method is only available to select developers approved by business units.
Important! (Limited Release) This method is only available to select developers approved by business units.
Important! (Limited Release) This method is only available to select developers approved by business units.
Important! (Limited Release) This method is only available to select developers approved by business units.
PAID
.PENDING
PASSED
FAILED
INELIGIBLE
EBAY_DE
marketplace can be shipped only to an address in Germany.GST
). The Goods and Services tax is only applicable to orders for the eBay Australia marketplace. For implementation help, refer to eBay API documentation"
}
},
"description": "This container defines the type of import tax applicable to the order, and the total amount of tax for all line items in the order."
},
"LegacyReference": {
"type": "object",
"properties": {
"legacyItemId": {
"type": "string",
"description": "The legacy ID used to identify an item.X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/Amount"
},
"fees": {
"type": "array",
"description": "A breakdown of the fees applicable to the line item.",
"items": {
"$ref": "#/components/schemas/Fee"
}
},
"image": {
"description": "An eBay-assigned URL of the item image.",
"$ref": "#/components/schemas/Image"
},
"itemId": {
"type": "string",
"description": "The eBay identifier of an item. This ID is returned by the Browse and Feed API methods. The ID is in RESTful item ID format.v1|2**********6|5**********4
or v1|1**********9|0
.v1|2**********6|5**********4
or v1|1**********9|0
.X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/Amount"
},
"fees": {
"type": "array",
"description": "A breakdown of the fees applicable to the line item.",
"items": {
"$ref": "#/components/schemas/Fee"
}
},
"image": {
"description": "An eBay-assigned URL of the item image.",
"$ref": "#/components/schemas/Image"
},
"itemId": {
"type": "string",
"description": "The eBay identifier of an item. This ID is returned by the Browse and Feed API methods."
},
"itemOnHold": {
"type": "boolean",
"description": "When this value is true
it indicates that the item has been put on hold due to a violation of eBay Policy."
},
"legacyReference": {
"description": "A container that returns fields to support using the Post Order API for returns and cancellations. For information about what is returned in these fields and how to use the Post Order API, see Using the Post Order API.FULFILLMENT_IN_PROGRESS
; without tracking information, eBay has no way of knowing whether the order was delivered. For implementation help, refer to eBay API documentation"
},
"netPrice": {
"description": "The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies.X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/Amount"
},
"deliveryDiscount": {
"description": "The total amount of the order delivery discounts for all of the line items, such as free shipping.",
"$ref": "#/components/schemas/Amount"
},
"fee": {
"description": "The total amount of any fees for all the line items in the order, such as a recycling fee.",
"$ref": "#/components/schemas/Amount"
},
"importCharges": {
"description": "The sum of all Global Shipping Program import charges, for all the line items in the order.",
"$ref": "#/components/schemas/Amount"
},
"importTax": {
"description": "The type of import tax applicable to the order, and the total amount of tax for all line items in the order.",
"$ref": "#/components/schemas/ImportTax"
},
"priceDiscount": {
"description": "The total discount amount for all line items in the order.X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/Amount"
},
"tax": {
"description": "The total amount of taxes for all line items in the order.",
"$ref": "#/components/schemas/Amount"
},
"total": {
"description": "The total cost of the order, which includes: (priceSubtotal - priceDiscount) + deliveryCost + tax +/- adjustment + fee + importCharges - additionalSavings.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "A type that returns cost details for all of the line items in the order, such as tax, item price, delivery cost, and discounts."
},
"PricingSummaryV2": {
"type": "object",
"properties": {
"additionalSavings": {
"description": "The total amount of the coupon discounts in the purchase order.",
"$ref": "#/components/schemas/Amount"
},
"adjustment": {
"description": "The total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the order that are not already captured in one of the other fields.",
"$ref": "#/components/schemas/Adjustment"
},
"deliveryCost": {
"description": "The delivery cost for all of the line items, after any delivery discounts are applied.X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/Amount"
},
"fee": {
"description": "The total amount of any fees for all the line items in the order, such as a recycling fee.",
"$ref": "#/components/schemas/Amount"
},
"importCharges": {
"description": "The sum of all Global Shipping Program import charges, for all the line items in the order.",
"$ref": "#/components/schemas/ImportChargesV2"
},
"importTax": {
"description": "The type of import tax applicable to the order, and the total amount of tax for all line items in the order.",
"$ref": "#/components/schemas/ImportTax"
},
"priceDiscount": {
"description": "The total discount amount for all line items in the order.X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/Amount"
},
"tax": {
"description": "The total amount of taxes for all line items in the order.",
"$ref": "#/components/schemas/Amount"
},
"total": {
"description": "The total cost of the order, which includes: (priceSubtotal - priceDiscount) + deliveryCost + tax +/- adjustment + fee + importCharges - additionalSavings.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "A type that returns cost details for all of the line items in the order, such as tax, item price, delivery cost, and discounts."
},
"Promotion": {
"type": "object",
"properties": {
"discount": {
"description": "The details regarding the monetary value of the promotional discount.SellerDiscountedPromotionalOffer
and COUPON
."
}
},
"description": "A container that returns the details of an item promotion."
},
"Recipient": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The first name of the person receiving the purchase order."
},
"lastName": {
"type": "string",
"description": "The last name of the person receiving the purchase order."
}
},
"description": "A container that defines the full name of the person receiving the purchase order."
},
"Region": {
"type": "object",
"properties": {
"regionName": {
"type": "string",
"description": "A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level, or at the country level in the case of VAT tax."
},
"regionType": {
"type": "string",
"description": "An enumeration value that indicates the type of region for the tax jurisdiction.STATE_OR_PROVINCE
COUNTRY
4********4
, you would enter +14********4
. If you do not include this code, the service will use the country specified in the country field.4********4
, you would enter +14********4
. If you do not include this code, the service will use the country specified in the country field.X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/Amount"
},
"deliveryDiscount": {
"description": "The monetary value of any delivery discounts.",
"$ref": "#/components/schemas/Amount"
},
"importCharges": {
"description": "The Global Shipping Program import charges for this line item.",
"$ref": "#/components/schemas/Amount"
},
"maxEstimatedDeliveryDate": {
"type": "string",
"description": "The end of the date range in which the purchase order is expected to be delivered to the shipping address."
},
"minEstimatedDeliveryDate": {
"type": "string",
"description": "The beginning of the date range in which the purchase order is expected to be delivered to the shipping address."
},
"selected": {
"type": "boolean",
"description": "A field that indicates whether the shipping method is selected."
},
"shippingCarrierCode": {
"type": "string",
"description": "The shipping provider for the line item, such as FedEx or USPS."
},
"shippingOptionId": {
"type": "string",
"description": "A unique ID for the selected shipping option/method."
},
"shippingServiceCode": {
"type": "string",
"description": "The name of the shipping service code. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx)."
}
},
"description": "A type that defines the fields for the shipping options."
},
"TaxDetail": {
"type": "object",
"properties": {
"includedInPrice": {
"type": "boolean",
"description": "A field that indicates whether tax was applied for the cost of the item and its shipping."
},
"taxJurisdiction": {
"description": "A container that returns the tax jurisdiction information.",
"$ref": "#/components/schemas/TaxJurisdiction"
},
"taxType": {
"type": "string",
"description": "A field that indicates the type of tax that may be collected for the item. For implementation help, refer to eBay API documentation"
}
},
"description": "A type that defines the tax fields."
},
"TaxJurisdiction": {
"type": "object",
"properties": {
"region": {
"description": "The region of the tax jurisdiction.",
"$ref": "#/components/schemas/Region"
},
"taxJurisdictionId": {
"type": "string",
"description": "The identifier of the tax jurisdiction."
}
},
"description": "The type that defines the fields for the tax jurisdiction details."
},
"UpdateQuantity": {
"type": "object",
"properties": {
"lineItemId": {
"type": "string",
"description": "A unique eBay-assigned ID value that identifies a line item in a purchase order.v1|2**********6|5**********4
or v1|1**********9|0
.v1|2**********6|5**********4
or v1|1**********9|0
.