{ "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(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://developer.ebay.com/join/api-license-agreement" }, "version": "v2.1.4" }, "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(Limited Release) This method is only available to select developers approved by business units.


This method adds a coupon to an eBay guest checkout session and applies it to all the eligible items in the order.

The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "applyGuestCoupon", "parameters": [ { "name": "checkoutSessionId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned session identifier for a specific eBay marketplace.

This value is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created.
See HTTP request headers for the marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The container for the fields used to apply a coupon to a guest checkout session.", "content": { "application/json": { "schema": { "description": "The container for the fields used to apply a coupon to a guest checkout session.", "$ref": "#/components/schemas/CouponRequest" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestCheckoutSessionResponseV2" } } }, "x-response-codes": { "errors": { "16026": { "domain": "API_ORDER", "category": "BUSINESS", "description": "You cannot apply multiple coupons to the same order. Check appliedCoupons to see which coupon is currently applied." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15001": { "domain": "API_ORDER", "category": "REQUEST", "description": "Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call." }, "15002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call." }, "15003": { "domain": "API_ORDER", "category": "REQUEST", "description": "The checkout session requested does not exist." }, "15025": { "domain": "API_ORDER", "category": "REQUEST", "description": "The App is not authorized to access this resource." }, "15029": { "domain": "API_ORDER", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." }, "15032": { "domain": "API_ORDER", "category": "REQUEST", "description": "After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call." }, "16002": { "domain": "API_ORDER", "category": "REQUEST", "description": "The coupon does not exist. The coupon was ignored and no discount was applied to this order." }, "16003": { "domain": "API_ORDER", "category": "REQUEST", "description": "The coupon has expired. No discount was applied to this order." }, "16004": { "domain": "API_ORDER", "category": "REQUEST", "description": "The coupon has not been activated. The coupon was ignored and no discount was applied to this order." }, "16006": { "domain": "API_ORDER", "category": "REQUEST", "description": "The coupon code is invalid. The coupon was ignored and no discount was applied to this order." }, "16022": { "domain": "API_ORDER", "category": "REQUEST", "description": "The coupon code is invalid. The coupon was ignored and no discount was applied to this order." }, "16024": { "domain": "API_ORDER", "category": "REQUEST", "description": "The coupon provided could not be applied. You may proceed with this session or provide another coupon." } } } }, "403": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15019": { "domain": "API_ORDER", "category": "BUSINESS", "description": "To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session." }, "15021": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This checkout session cannot be updated because the order has already been placed." }, "15027": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}." }, "16000": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is not valid for any of the items in the order. The coupon was ignored and no discount was applied to this order." }, "16001": { "domain": "API_ORDER", "category": "BUSINESS", "description": "You cannot apply multiple coupons to the same order. No discount was applied to this order." }, "16005": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon requires the buyer to spend a specific monetary amount. This threshold has not been met. The coupon was ignored and no discount was applied to this order." }, "16007": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This coupon has already been used. The coupon was ignored and no discount was applied to this order." }, "16008": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This coupon is no longer valid. The coupon was ignored and no discount was applied to this order." }, "16009": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon requires the buyer to spend a specific monetary amount. This threshold has not been met. The coupon was ignored and no discount was applied to this order." }, "16010": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is not valid for the currency being used by the items. The coupon was ignored and no discount was applied to this order." }, "16012": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is not valid for the {fieldName}. The coupon was ignored and no discount was applied to this order." }, "16013": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is not valid for any of the item categories in the order. The coupon was ignored and no discount was applied to this order." }, "16014": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is not valid for the selected payment method. The coupon was ignored and no discount was applied to this order." }, "16015": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is not valid for the selected shipping option. The coupon was ignored and no discount was applied to this order." }, "16016": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is valid only for items that are shipped domestically. The coupon was ignored and no discount was applied to this order." }, "16017": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is valid only for items that are shipped internationally. The coupon was ignored and no discount was applied to this order." }, "16018": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The buyer is not eligible for this coupon. The coupon was ignored and no discount was applied to this order." }, "16019": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The coupon is not valid for guest eBay checkouts. The coupon was ignored and no discount was applied to this order." }, "16023": { "domain": "API_ORDER", "category": "BUSINESS", "description": "You cannot apply multiple coupons to the same order. The coupon was ignored and no discount was applied to this order." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15000": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." }, "16020": { "domain": "API_ORDER", "category": "APPLICATION", "description": "Your application is not eligible for this coupon. The coupon was ignored and no discount was applied to this order." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] } }, "/guest_checkout_session/{checkoutSessionId}": { "get": { "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(Limited Release) This method is only available to select developers approved by business units.


This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "getGuestCheckoutSession", "parameters": [ { "name": "checkoutSessionId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned session identifier for a specific eBay marketplace.

This value is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created.
See HTTP request headers for the marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestCheckoutSessionResponseV2" } } }, "x-response-codes": { "errors": { "20000": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This order contains the item {itemId} that may be subject to certain importation permitting/licensing requirements. Please check applicable regulations for specific import restrictions in your country." }, "20001": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This item {itemId} ships via a freight carrier. For information regarding shipping, tracking, delivery, etc. check with the seller." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15003": { "domain": "API_ORDER", "category": "REQUEST", "description": "The checkout session requested does not exist." }, "15025": { "domain": "API_ORDER", "category": "REQUEST", "description": "The App is not authorized to access this resource." }, "15029": { "domain": "API_ORDER", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." } } } }, "403": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15027": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15000": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] } }, "/guest_checkout_session/initiate": { "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(Limited Release) This method is only available to select developers approved by business units.


This method creates an eBay guest checkout session, which is the first step in performing a checkout. The method returns a checkoutSessionId that you use as a URI parameter in subsequent guest checkout methods.

Note: This method also returns the X-EBAY-SECURITY-SIGNATURE response header, which is a token that is used to launch the Checkout with eBay widget. The Checkout with eBay widget allows eBay guests to pay for items without leaving your site. For details about the Checkout with eBay widget, see Integrating the Checkout with eBay button.
Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs.

TIP: To test the entire checkout flow, you might need a \"test\" credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com.
For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "initiateGuestCheckoutSession", "parameters": [ { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

See HTTP request headers for the marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The container for the fields used by the initiateGuestCheckoutSession method.", "content": { "application/json": { "schema": { "description": "The container for the fields used by the initiateGuestCheckoutSession method.", "$ref": "#/components/schemas/CreateGuestCheckoutSessionRequestV2" } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { "X-EBAY-SECURITY-SIGNATURE": { "schema": { "type": "string", "description": "A token that is used to launch the Checkout with eBay widget. For details about the Checkout with eBay widget, see Integrating the Checkout with eBay button" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestCheckoutSessionResponseV2" } } }, "x-response-codes": { "errors": { "15007": { "domain": "API_ORDER", "category": "REQUEST", "description": "The address provided may be incorrect. You may proceed with this address or provide a correct address." }, "15043": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item {itemId} cannot be purchased using this API and has been removed from the cart. The purchase can be done on ebay.com." }, "15055": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item is removed due to one or more reasons (out of stock, the desired quantity exceeds the quantity available, etc)." }, "20000": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This order contains the item {itemId} that may be subject to certain importation permitting/licensing requirements. Please check applicable regulations for specific import restrictions in your country." }, "20001": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This item {itemId} ships via a freight carrier. For information regarding shipping, tracking, delivery, etc. check with the seller." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15001": { "domain": "API_ORDER", "category": "REQUEST", "description": "Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call." }, "15002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call." }, "15029": { "domain": "API_ORDER", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." }, "15048": { "domain": "API_ORDER", "category": "REQUEST", "description": "The value of {fieldName} is too long. For more information, see the documentation for this call." }, "17002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid character(s) found in the shipping address. Please check name and shipping address fields, remove invalid character(s) and resubmit the call." } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15011": { "domain": "API_ORDER", "category": "BUSINESS", "description": "You have exceeded the maximum number of {maxLineItems} line items. Correct the request and resubmit the call." }, "15012": { "domain": "API_ORDER", "category": "BUSINESS", "description": "There is a limit on the quantity of this item that can be purchased. Reduce the quantity and resubmit the call." }, "15013": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item is either out of stock, or the desired quantity exceeds the quantity available. If out of stock, please wait for seller to restock. If desired quantity exceeds available quantity, please reduce the quantity value and try again." }, "15014": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The quantity submitted for this item is invalid. Correct the quantity value and resubmit the call." }, "15015": { "domain": "API_ORDER", "category": "BUSINESS", "description": "There is a problem with the credit card and it cannot be used to purchase items. Use the updatePaymentInfo call to change the payment information." }, "15017": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The payment for the order line items in your cart could not be processed due to issues with one or more sellers." }, "15018": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item is not available for purchase. This can be for several reasons including the listing has ended. Remove the item and resubmit the call." }, "15019": { "domain": "API_ORDER", "category": "BUSINESS", "description": "To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session." }, "15026": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item is not shippable to the specified shipping address." }, "15027": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}." }, "15028": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item {itemId} is not available for purchase because it cannot be shipped to {country}." }, "15031": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item is not purchasable because the buyer has been blocked by the seller." }, "15044": { "domain": "API_ORDER", "category": "BUSINESS", "description": "At least one of the items in the cart cannot be purchased using this API. The purchase can be done on eBay, through the eBay app or eBay website." }, "15045": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item cannot be purchased because the seller is away and is not processing orders. If you are trying to purchase more than one item, you need to create a new checkout session to purchase the other items." }, "15047": { "domain": "API_ORDER", "category": "BUSINESS", "description": "In compliance with applicable economic sanctions and trade restrictions, eBay is unavailable in your location. If you believe you are receiving this notice in error, please contact eBay's Customer Service." }, "15053": { "domain": "API_ORDER", "category": "BUSINESS", "description": "Your desired item(s) are not available for purchase at this time. The unavailability of an item could be for any of several reasons, including the item being out of stock. Add available item(s) and resubmit the call." }, "20002": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This item {itemId} is currently unavailable to buy from the seller." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15000": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] } }, "/guest_checkout_session/{checkoutSessionId}/remove_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(Limited Release) This method is only available to select developers approved by business units.


This method removes a coupon from an eBay guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "removeGuestCoupon", "parameters": [ { "name": "checkoutSessionId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned session identifier for a specific eBay marketplace.

This value is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created.
See HTTP request headers for the marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The container for the fields used by the removeGuestCoupon method.", "content": { "application/json": { "schema": { "description": "The container for the fields used by the removeGuestCoupon method.", "$ref": "#/components/schemas/CouponRequest" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestCheckoutSessionResponseV2" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15001": { "domain": "API_ORDER", "category": "REQUEST", "description": "Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call." }, "15002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call." }, "15003": { "domain": "API_ORDER", "category": "REQUEST", "description": "The checkout session requested does not exist." }, "15025": { "domain": "API_ORDER", "category": "REQUEST", "description": "The App is not authorized to access this resource." }, "15029": { "domain": "API_ORDER", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." }, "15032": { "domain": "API_ORDER", "category": "REQUEST", "description": "After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call." }, "15033": { "domain": "API_ORDER", "category": "REQUEST", "description": "The payment cannot be processed because the payment information is invalid. You will need to create a new checkout session and submit corrected payment information." }, "16025": { "domain": "API_ORDER", "category": "REQUEST", "description": "The coupon was not applied to this cart." } } } }, "403": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15019": { "domain": "API_ORDER", "category": "BUSINESS", "description": "To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session." }, "15021": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This checkout session cannot be updated because the order has already been placed." }, "15027": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15000": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] } }, "/guest_checkout_session/{checkoutSessionId}/update_quantity": { "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(Limited Release) This method is only available to select developers approved by business units.


This method changes the quantity of the specified line item in an eBay guest checkout session.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "updateGuestQuantity", "parameters": [ { "name": "checkoutSessionId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned session identifier for a specific eBay marketplace.

This value is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created.
See HTTP request headers for the marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The container for the fields used by the updateGuestQuantity method.", "content": { "application/json": { "schema": { "description": "The container for the fields used by the updateGuestQuantity method.", "$ref": "#/components/schemas/UpdateQuantity" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestCheckoutSessionResponseV2" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15001": { "domain": "API_ORDER", "category": "REQUEST", "description": "Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call." }, "15002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call." }, "15003": { "domain": "API_ORDER", "category": "REQUEST", "description": "The checkout session requested does not exist." }, "15025": { "domain": "API_ORDER", "category": "REQUEST", "description": "The App is not authorized to access this resource." }, "15029": { "domain": "API_ORDER", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." }, "15032": { "domain": "API_ORDER", "category": "REQUEST", "description": "After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call." } } } }, "403": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15012": { "domain": "API_ORDER", "category": "BUSINESS", "description": "There is a limit on the quantity of this item that can be purchased. Reduce the quantity and resubmit the call." }, "15013": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item is either out of stock, or the desired quantity exceeds the quantity available. If out of stock, please wait for seller to restock. If desired quantity exceeds available quantity, please reduce the quantity value and try again." }, "15014": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The quantity submitted for this item is invalid. Correct the quantity value and resubmit the call." }, "15019": { "domain": "API_ORDER", "category": "BUSINESS", "description": "To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session." }, "15021": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This checkout session cannot be updated because the order has already been placed." }, "15027": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}." }, "15053": { "domain": "API_ORDER", "category": "BUSINESS", "description": "Your desired item(s) are not available for purchase at this time. The unavailability of an item could be for any of several reasons, including the item being out of stock. Add available item(s) and resubmit the call." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15000": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] } }, "/guest_checkout_session/{checkoutSessionId}/update_shipping_address": { "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(Limited Release) This method is only available to select developers approved by business units.


This method changes the shipping address for the order in an eBay guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item.

Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address.
For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "updateGuestShippingAddress", "parameters": [ { "name": "checkoutSessionId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned session identifier for a specific eBay marketplace.

This value is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created.
See HTTP request headers for the marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The container for the fields used by the updateGuestShippingAddress method.", "content": { "application/json": { "schema": { "description": "The container for the fields used by the updateGuestShippingAddress method.", "$ref": "#/components/schemas/ShippingAddressImpl" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestCheckoutSessionResponseV2" } } }, "x-response-codes": { "errors": { "15007": { "domain": "API_ORDER", "category": "REQUEST", "description": "The address provided may be incorrect. You may proceed with this address or provide a correct address." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15001": { "domain": "API_ORDER", "category": "REQUEST", "description": "Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call." }, "15002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call." }, "15003": { "domain": "API_ORDER", "category": "REQUEST", "description": "The checkout session requested does not exist." }, "15025": { "domain": "API_ORDER", "category": "REQUEST", "description": "The App is not authorized to access this resource." }, "15029": { "domain": "API_ORDER", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." }, "15032": { "domain": "API_ORDER", "category": "REQUEST", "description": "After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call." }, "15048": { "domain": "API_ORDER", "category": "REQUEST", "description": "The value of {fieldName} is too long. For more information, see the documentation for this call." }, "17002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid character(s) found in the shipping address. Please check name and shipping address fields, remove invalid character(s) and resubmit the call." } } } }, "403": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15019": { "domain": "API_ORDER", "category": "BUSINESS", "description": "To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session." }, "15021": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This checkout session cannot be updated because the order has already been placed." }, "15026": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The item is not shippable to the specified shipping address." }, "15027": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}." }, "15047": { "domain": "API_ORDER", "category": "BUSINESS", "description": "In compliance with applicable economic sanctions and trade restrictions, eBay is unavailable in your location. If you believe you are receiving this notice in error, please contact eBay's Customer Service." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15000": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] } }, "/guest_checkout_session/{checkoutSessionId}/update_shipping_option": { "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(Limited Release) This method is only available to select developers approved by business units.


This method changes the shipping method for the specified line item in an eBay guest checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "updateGuestShippingOption", "parameters": [ { "name": "checkoutSessionId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned session identifier for a specific eBay marketplace.

This value is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created.
See HTTP request headers for the marketplace ID values.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The container for the fields used by the updateGuestShippingOption method.", "content": { "application/json": { "schema": { "description": "The container for the fields used by the updateGuestShippingOption method.", "$ref": "#/components/schemas/UpdateShippingOption" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestCheckoutSessionResponseV2" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15001": { "domain": "API_ORDER", "category": "REQUEST", "description": "Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call." }, "15002": { "domain": "API_ORDER", "category": "REQUEST", "description": "Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call." }, "15003": { "domain": "API_ORDER", "category": "REQUEST", "description": "The checkout session requested does not exist." }, "15025": { "domain": "API_ORDER", "category": "REQUEST", "description": "The App is not authorized to access this resource." }, "15029": { "domain": "API_ORDER", "category": "REQUEST", "description": "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." }, "15032": { "domain": "API_ORDER", "category": "REQUEST", "description": "After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call." } } } }, "403": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15019": { "domain": "API_ORDER", "category": "BUSINESS", "description": "To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session." }, "15021": { "domain": "API_ORDER", "category": "BUSINESS", "description": "This checkout session cannot be updated because the order has already been placed." }, "15027": { "domain": "API_ORDER", "category": "BUSINESS", "description": "The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "15000": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] } }, "/guest_purchase_order/{purchaseOrderId}": { "get": { "tags": [ "guest_purchase_order" ], "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(Limited Release) This method is only available to select developers approved by business units.


This method retrieves the details about a specific guest purchase order. It returns the line items, including purchase order status, dates created and modified, item quantity and listing data, payment and shipping information, and prices, taxes, discounts and credits.

The purchaseOrderId is passed in as a URI parameter and is required.

Note: The purchaseOrderId value is returned in the call-back URL that is sent through the new eBay pay widget. For more information about eBay managed payments and the new Order API payment flow, see Order API in the Buying Integration Guide.
You can use this method to not only get the details of a purchase order, but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.", "operationId": "getGuestPurchaseOrder", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "This path parameter specifies the unique identifier of a purchase order made by a guest buyer, for which details are to be retrieved.

Note: This value is returned in the response URL that is sent through the new eBay pay widget. For more information about eBay managed payments and the new Order API payment flow, see Order API in the Buying Integration Guide.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the eBay marketplace where the order will occur.

Note: For this method, this value must match the X-EBAY-C-MARKETPLACE-ID used when the associated checkout session was created.
See HTTP request headers for the marketplace ID values.", "required": false, "schema": { "type": "string" } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is used to specify the deviceId for the device/user attempting to make the call.

It contains an alphanumeric string that allows a payment gateway to track an API call attempt and confirm that it is a verified payment attempt by a device/user.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestPurchaseOrderV2" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "16002": { "domain": "API_ORDER", "category": "REQUEST", "description": "The purchase order ID was not found." }, "16003": { "domain": "API_ORDER", "category": "REQUEST", "description": "Access to the purchase order is not authorized." } } } }, "403": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "16001": { "domain": "API_ORDER", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.guest.order" ] } ] }, "servers": [ { "url": "https://api.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/buy/order/v2" } } } ] } }, "components": { "schemas": { "AddonService": { "type": "object", "properties": { "serviceFee": { "description": "The container that returns the amount and currency of the fee for an add-on service.", "$ref": "#/components/schemas/Amount" }, "serviceTax": { "description": "The container that returns the amount and currency of the sales tax applied against the add-on service fee. This tax is based on the state or territory in which the buyer is located.", "$ref": "#/components/schemas/Amount" }, "serviceType": { "type": "string", "description": "An enumerated value that defines the type of add-on service. For implementation help, refer to eBay API documentation" } }, "description": "A type that defines the fields for add-on services that may be applied or are automatically applied to an item in an order." }, "Adjustment": { "type": "object", "properties": { "amount": { "description": "The container that returns the amount and currency of an adjustment.", "$ref": "#/components/schemas/Amount" }, "label": { "type": "string", "description": "The text indicating what the adjustment was for." } }, "description": "A type that defines the fields for seller adjustments. An adjustment can be a credit or debit." }, "Amount": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item. For implementation help, refer to eBay API documentation" }, "value": { "type": "string", "description": "The amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item." } }, "description": "The type defining the monetary value of an amount in the currency used in on the eBay site offering the item and the conversion of that value into another currency." }, "ApiPricingSummaryV2": { "type": "object", "properties": { "additionalSavings": { "description": "The total amount of the coupon discounts in the purchase order.", "$ref": "#/components/schemas/Amount" }, "addonServicesFee": { "description": "The total fee for add-on services among all line items.", "$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.

For example, there are four line items, and the delivery cost for each line item is $5. One of the line items qualifies for free delivery. The deliveryCost would be $15, which is the total cost for delivering all of the line items after the discount is applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the 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" }, "importDuties": { "description": "The total sum of cross-border import duties calculated for all line items in the order, which is paid by the buyer at checkout.", "$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.

For example, there are four line items in the order. Two of the line items qualify for a Buy 1, Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value returned would be 21, which is the total of the two discounts.

Note: Delivery discount amounts, if applicable, are not reflected in the value returned in this field.", "$ref": "#/components/schemas/Amount" }, "priceSubtotal": { "description": "The total cost for all line items in the order, taking into account the item quantity, but before adding taxes and delivery costs, or applying discounts, fees, and adjustments.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the 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." }, "AuthenticityVerificationProgram": { "type": "object", "properties": { "description": { "type": "string", "description": "An informational message that applies to the Authenticity Guarantee program." }, "outcomeReason": { "type": "string", "description": "An informational message regarding the authentication outcome of an Authenticity Guarantee verification inspection.

Note: This field is conditionally returned when there is information that applies to the Authenticity Guarantee program." }, "status": { "type": "string", "description": "An enumerated value that indicates whether the order line item has passed or failed the Authenticity Guarantee verification inspection, or whether the inspection and/or results are still pending.

Note: This field is conditionally returned when the purchase is complete.

Valid Values: For implementation help, refer to eBay API documentation" }, "termsWebUrl": { "type": "string", "description": "The terms and conditions that apply to the Authenticity Guarantee program." } }, "description": "A type that provides the status and outcome of an order line item going through the Authenticity Guarantee verification process." }, "CheckoutAddonService": { "type": "object", "properties": { "selected": { "type": "boolean", "description": "This boolean indicates whether the service is selected or not." }, "serviceFee": { "description": "The container that returns the amount and currency of the fee for an add-on service.", "$ref": "#/components/schemas/Amount" }, "serviceId": { "type": "string", "description": "The unique identifier of the add-on service." }, "serviceTax": { "description": "The container that returns the amount and currency of the sales tax applied against the add-on service fee. This tax is based on the state or territory in which the buyer is located.", "$ref": "#/components/schemas/Amount" }, "serviceType": { "type": "string", "description": "The type of add-on service, such as AUTHENTICITY_GUARANTEE. For implementation help, refer to eBay API documentation" } }, "description": "A type that defines the fields for add-on services that may be applied or are automatically applied to an item in an order." }, "ChkPricingSummaryV2": { "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.

For example, there are four line items, and the delivery cost for each line item is $5. One of the line items qualifies for free delivery. The deliveryCost would be $15, which is the total cost for delivering all of the line items after the discount is applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the 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.

For example, there are four line items in the order. Two of the line items qualify for a Buy 1, Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value returned would be 21, which is the total of the two discounts.

Note: Delivery discount amounts, if applicable, are not reflected in the value returned in this field.", "$ref": "#/components/schemas/Amount" }, "priceSubtotal": { "description": "The total cost for all line items in the order, taking into account the item quantity, but before adding taxes and delivery costs, or applying discounts, fees, and adjustments.

Note: The price includes the value-added tax (VAT) and/or Buyer Protection fee for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see tax-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." }, "Coupon": { "type": "object", "properties": { "redemptionCode": { "type": "string", "description": "The coupon redemption code." } }, "description": "A type that defines the fields for the coupon information.

Note: This container is not returned for the getGuestPurchaseOrder method." }, "CouponRequest": { "type": "object", "properties": { "redemptionCode": { "type": "string", "description": "The redemption code of the coupon.

Maximum: One redemption code per order" } }, "description": "A type that defines the fields for the coupon information used in the request." }, "CreateGuestCheckoutSessionRequestV2": { "type": "object", "properties": { "contactEmail": { "type": "string", "description": "The buyer's email address." }, "lineItemInputs": { "type": "array", "description": "An array used to define the line item(s) and desired quantity for an eBay guest checkout session.

Maximum: 10 line items", "items": { "$ref": "#/components/schemas/LineItemInput" } }, "shippingAddress": { "description": "A container that defines the shipping address for an eBay guest checkout session.

Note: If the address cannot be validated, a warning message is returned along with the response.", "$ref": "#/components/schemas/ShippingAddress" } }, "description": "A type that defines the fields used to create an eBay guest checkout session." }, "Error": { "type": "object", "properties": { "category": { "type": "string", "description": "This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors." }, "domain": { "type": "string", "description": "The name of the primary system where the error occurred. This is relevant for application errors." }, "errorId": { "type": "integer", "description": "A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "A detailed description of the condition that caused the error or warning, and information on what what must be done to correct the problem." }, "message": { "type": "string", "description": "A description of the condition that caused the error or warning." }, "outputRefIds": { "type": "array", "description": "An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.", "items": { "$ref": "#/components/schemas/ErrorParameter" } }, "subdomain": { "type": "string", "description": "The name of the subdomain in which the error or warning occurred." } }, "description": "A type that defines the fields for the error messages." }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the input field that caused an issue with the method request." }, "value": { "type": "string", "description": "The actual value that was passed in for the element specified in the name field." } }, "description": "An array of name/value pairs that provide details regarding the error." }, "Fee": { "type": "object", "properties": { "amount": { "description": "A container for the currency type and monetary amount of the fee associated with the line item.", "$ref": "#/components/schemas/Amount" }, "feeType": { "type": "string", "description": "The type of fee associated with the line item. For implementation help, refer to eBay API documentation" } }, "description": "A breakdown of the fees associated with the line item." }, "GuestCheckoutSessionResponseV2": { "type": "object", "properties": { "appliedCoupons": { "type": "array", "description": "A container that returns the information for the coupons that were applied in the guest checkout session.", "items": { "$ref": "#/components/schemas/Coupon" } }, "checkoutSessionId": { "type": "string", "description": "The eBay-assigned guest checkout session ID. This ID is created after a successful initiateGuestCheckoutSession call." }, "lineItems": { "type": "array", "description": "An array of line items associated with the guest checkout session.", "items": { "$ref": "#/components/schemas/LineItem" } }, "pricingSummary": { "description": "A container that breaks down the costs for the order, including total cost, shipping cost, tax, fees, and any discounts.", "$ref": "#/components/schemas/ChkPricingSummaryV2" }, "shippingAddress": { "description": "A container that returns the address to which the purchase order will be shipped.", "$ref": "#/components/schemas/ShippingAddress" }, "warnings": { "type": "array", "description": "An array of errors or warnings that were generated during the method processing.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "Guest session response v2 " }, "GuestPurchaseOrderV2": { "type": "object", "properties": { "lineItems": { "type": "array", "description": "An array of line items in the order.", "items": { "$ref": "#/components/schemas/OrderLineItemV2" } }, "pricingSummary": { "description": "A container that breaks down the costs for the order, including total cost, shipping cost, tax, fees, and any discounts.", "$ref": "#/components/schemas/ApiPricingSummaryV2" }, "purchaseOrderCreationDate": { "type": "string", "description": "The creation date of the purchase order." }, "purchaseOrderId": { "type": "string", "description": "The unique identifier of the purchase order." }, "purchaseOrderPaymentStatus": { "type": "string", "description": "A container that returns the payment status for the purchase order. For implementation help, refer to eBay API documentation" }, "purchaseOrderStatus": { "type": "string", "description": "An enumeration value that indicates the current status of the buyer's payment and any refund that applies to the purchase order. For implementation help, refer to eBay API documentation" }, "refundedAmount": { "description": "The total amount of any refunds for the purchase order.", "$ref": "#/components/schemas/Amount" }, "taxDetails": { "type": "array", "description": "Detailed tax information for items included in this order.", "items": { "$ref": "#/components/schemas/TaxDetails" } }, "warnings": { "type": "array", "description": "A container for any warning messages.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "A type that defines the fields for a guest purchase order." }, "Image": { "type": "object", "properties": { "imageUrl": { "type": "string", "description": "The URL for the image." } }, "description": "A container that returns the URL for an image." }, "ImportChargesV2": { "type": "object", "properties": { "amount": { "description": "The amount of the import charge.", "$ref": "#/components/schemas/Amount" }, "applicableChargeType": { "type": "string", "description": "The type of charge to apply to the order, such as import duties. For implementation help, refer to eBay API documentation" } }, "description": "A type that defines the import charges that apply to an order." }, "ImportTax": { "type": "object", "properties": { "amount": { "description": "The total amount of import tax for all line items of an order.", "$ref": "#/components/schemas/Amount" }, "importTaxType": { "type": "string", "description": "An enumeration value that indicates the type of import tax applicable to the order. Currently, the only applicable import tax is the Goods and Services tax (indicated with 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.

This is used by the Post Order API Create Return Request method. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Create a return request in the Buy Integration Guide.

Restriction: The Post Order API can be used only with eBay member checkouts." }, "legacyOrderId": { "type": "string", "description": "The legacy ID of the order.

This is used by the Post Order API Submit Cancellation Request method. This method initiates the item cancellation process. For more information on how to use this field in the Post Order API, see Using the Post Order API.

Restriction: The Post Order API can be used only with eBay member checkouts." }, "legacyTransactionId": { "type": "string", "description": "The legacy ID of the transaction.

This is used by the Post Order API Create Return Request call. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Using the Post Order API in the Buy Integration Guide.

Restriction: The Post Order API can be used only with eBay member checkouts." } }, "description": "A type that defines the fields to support using the Post Order API for returns and cancellations.

Restriction: The Post Order API can be used only with eBay member checkouts." }, "LineItem": { "type": "object", "properties": { "addonServices": { "type": "array", "description": "An array of add-on services for the line item.", "items": { "$ref": "#/components/schemas/CheckoutAddonService" } }, "authenticityVerification": { "description": "A container returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer.", "$ref": "#/components/schemas/AuthenticityVerificationProgram" }, "baseUnitPrice": { "description": "The cost of a single quantity of the line item. This is the starting point for computing the price during the checkout session.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the 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.

For example: v1|2**********6|5**********4 or v1|1**********9|0.

For more information about item IDs for RESTful APIs, see Legacy API compatibility." }, "lineItemId": { "type": "string", "description": "A unique eBay-assigned ID value that identifies a line item in a checkout session." }, "netPrice": { "description": "The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies.

Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments.", "$ref": "#/components/schemas/Amount" }, "promotions": { "type": "array", "description": "An array of promotions applied to the line item.", "items": { "$ref": "#/components/schemas/Promotion" } }, "quantity": { "type": "integer", "description": "The quantity ordered for the line item.", "format": "int32" }, "seller": { "description": "A container that returns the information about the seller, such as their eBay user name.", "$ref": "#/components/schemas/Seller" }, "shippingOptions": { "type": "array", "description": "An array of shipping options that are available for the line item. By default, the first one will be selected.

Note: The updateGuestShippingOption method can be used to change the shipping option.", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "taxDetails": { "type": "array", "description": "A container that returns the tax information for the line item.", "items": { "$ref": "#/components/schemas/TaxDetail" } }, "title": { "type": "string", "description": "The seller-created title of the item." } }, "description": "A type that defines the fields for an individual line item." }, "LineItemInput": { "type": "object", "properties": { "itemId": { "type": "string", "description": "The unique eBay-assigned identifier of an item. This ID is returned by the Browse and Feed API methods. The ID must be in RESTful item ID format.

For example: v1|2**********6|5**********4 or v1|1**********9|0.

For more information about item IDs for RESTful APIs, see Legacy API compatibility.

Each itemId will become a single line item.

Maximum: 10 per session" }, "quantity": { "type": "integer", "description": "The quantity ordered in this line item.", "format": "int32" } }, "description": "A type that defines the fields for a line item." }, "OrderLineItemV2": { "type": "object", "properties": { "addonServices": { "type": "array", "description": "An array of add-on services that apply to the order line item.", "items": { "$ref": "#/components/schemas/AddonService" } }, "authenticityVerification": { "description": "A container that is returned for orders that are eligible for eBay's Authenticity Guarantee program. The seller ships Authenticity Guarantee program items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer.", "$ref": "#/components/schemas/AuthenticityVerificationProgram" }, "baseUnitPrice": { "description": "The cost of a single quantity of the line item.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the 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.

Note: The Post Order API can be used only with eBay member checkouts.", "$ref": "#/components/schemas/LegacyReference" }, "lineItemId": { "type": "string", "description": "A unique eBay-assigned ID value that identifies a line item in a checkout session. This is created by the initiateGuestCheckoutSession." }, "lineItemPaymentStatus": { "type": "string", "description": "An enumeration value that indicates the payment status of the line item. For implementation help, refer to eBay API documentation" }, "lineItemStatus": { "type": "string", "description": "An enumeration value that indicates the fulfillment state of this line item.

Note: When there is no tracking information, the status will never change from 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.

Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments.", "$ref": "#/components/schemas/Amount" }, "orderId": { "type": "string", "description": "The unique order ID for the line item.

Maximum Length: 40 characters" }, "promotions": { "type": "array", "description": "An array of promotions applied to the line item.", "items": { "$ref": "#/components/schemas/Promotion" } }, "quantity": { "type": "integer", "description": "The quantity ordered for the line item.", "format": "int32" }, "seller": { "description": "A container for information about the seller offering this item, such as the seller's user name.", "$ref": "#/components/schemas/Seller" }, "shippingDetail": { "description": "A container for information about the shipping details of the order.", "$ref": "#/components/schemas/ShippingDetail" }, "taxDetails": { "type": "array", "description": "A container for the tax information for the line item.

Note: The information in this container is only returned when requested from the GB marketplace, when applicable.", "items": { "$ref": "#/components/schemas/TaxDetail" } }, "title": { "type": "string", "description": "The seller-created title of the item." } }, "description": "A type that defines the fields for line item information in a purchase order." }, "Promotion": { "type": "object", "properties": { "discount": { "description": "The details regarding the monetary value of the promotional discount.

Note: eBay Bucks are not supported.", "$ref": "#/components/schemas/Amount" }, "message": { "type": "string", "description": "The text for the promotion title, which describes the promotion." }, "promotionType": { "type": "string", "description": "The kind of promotion. Some examples are: 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.

Valid Values: For implementation help, refer to eBay API documentation" } }, "description": "A type that provides region details for a tax jurisdiction." }, "Seller": { "type": "object", "properties": { "username": { "type": "string", "description": "The user name created by the seller for use on eBay." } }, "description": "A type that identifies the seller." }, "ShippingAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "The first line of the street address where the item is being shipped.

Maximum:" }, "addressLine2": { "type": "string", "description": "The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'.

Maximum:" }, "city": { "type": "string", "description": "The city of the address where the item is being shipped." }, "country": { "type": "string", "description": "The two letter code representing the country of the address. For implementation help, refer to eBay API documentation" }, "county": { "type": "string", "description": "The county of the address where the item is being shipped." }, "phoneNumber": { "type": "string", "description": "The phone number of the person receiving the package.

Note: It is highly recommended that when entering the phone number you include the country code.

For example, if a US phone number is 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.

You can find the country code at https://countrycode.org." }, "postalCode": { "type": "string", "description": "The postal code of the address where the item is being shipped.

Note: This is optional when shipping to EBAY_HK (Hong Kong)." }, "recipient": { "description": "The name of the person receiving the package.", "$ref": "#/components/schemas/Recipient" }, "stateOrProvince": { "type": "string", "description": "The state or province of the address.

Note: For the US marketplace, this is a two-character value. For a list of valid values, see US State and Canada Province Codes. " } }, "description": "A type that defines the fields for a shipping address. For restrictions, see Shipping restrictions.

Note: If the address cannot be validated, a warning message will be returned." }, "ShippingAddressImpl": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "The first line of the street address where the item is being shipped.

Maximum:" }, "addressLine2": { "type": "string", "description": "The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'.

Maximum:" }, "city": { "type": "string", "description": "The city of the address where the item is being shipped." }, "country": { "type": "string", "description": "The two letter code representing the country of the address. For implementation help, refer to eBay API documentation" }, "county": { "type": "string", "description": "The county of the address where the item is being shipped." }, "phoneNumber": { "type": "string", "description": "The phone number of the person receiving the package.

Note: It is highly recommended that when entering the phone number you include the country code.

For example, if a US phone number is 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.

You can find the country code at https://countrycode.org." }, "postalCode": { "type": "string", "description": "The postal code of the address where the item is being shipped.

Note: This is optional when shipping to EBAY_HK (Hong Kong)." }, "recipient": { "description": "The name of the person receiving the package.", "$ref": "#/components/schemas/Recipient" }, "stateOrProvince": { "type": "string", "description": "The state or province of the address.

Note: For the US marketplace, this is a two-character value. For a list of valid values, see US State and Canada Province Codes. " } }, "description": "A type that defines the shipping address fields.

Note: If the address cannot be validated, a warning message is returned along with the response." }, "ShippingDetail": { "type": "object", "properties": { "ebayShipping": { "type": "boolean", "description": "This value indicates whether shipping for this order is managed by eBay (true) or by the seller (omitted if false or not applicable to the transaction).

When true, the value in the pricingSummary.deliveryCost container indicates the shipping cost paid directly by the buyer to eBay." }, "maxEstimatedDeliveryDate": { "type": "string", "description": "The end of the date range in which the purchase order is expected to be delivered to the shipping address (final destination)." }, "minEstimatedDeliveryDate": { "type": "string", "description": "The beginning of the date range in which the purchase order is expected to be delivered to the shipping address (final destination)." }, "shippingCarrierCode": { "type": "string", "description": "The shipping provider for the line item, such as FedEx or USPS." }, "shippingServiceCode": { "type": "string", "description": "The name of the shipping service option. 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 information, such as delivery date estimates and shipping provider." }, "ShippingOption": { "type": "object", "properties": { "baseDeliveryCost": { "description": "The delivery cost using this shipping option, for this line item, before any delivery discounts are applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the 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" }, "ebayShipping": { "type": "boolean", "description": "This value indicates whether shipping for this order is managed by eBay (true) or by the seller (false)." }, "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." }, "TaxClassificationDetail": { "type": "object", "properties": { "amount": { "description": "A container for the currency type and monetary amount of the tax collected for an item.", "$ref": "#/components/schemas/Amount" }, "taxType": { "type": "string", "description": "Indicates the type of tax that has been collected for the item. For implementation help, refer to eBay API documentation" } }, "description": "This type provides detailed information about the tax that has been collected for an item." }, "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." }, "TaxDetails": { "type": "object", "properties": { "amount": { "description": "A container for the currency type and monetary amount of the tax item.", "$ref": "#/components/schemas/Amount" }, "taxClassification": { "type": "string", "description": "Specifies what the tax item pertains to, such as a tangible object (ITEM_TAX), a service (SERVICE_TAX), or shipping fees (SHIPPING_TAX). For implementation help, refer to eBay API documentation" }, "taxClassificationDetails": { "type": "array", "description": "Provides a detailed accounting, by TaxType, of taxes collected for each item within an order.", "items": { "$ref": "#/components/schemas/TaxClassificationDetail" } } }, "description": "This type provides detailed information for taxes collected for each item within an order." }, "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.

For example: v1|2**********6|5**********4 or v1|1**********9|0.

For more information about item IDs for RESTful APIs, see Legacy API compatibility." }, "quantity": { "type": "integer", "description": "The quantity of the line item that you wish to update.", "format": "int32" } }, "description": "A type that defines the fields used to update the quantity of a line item." }, "UpdateShippingOption": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "A unique eBay-assigned ID value that identifies the line item in a checkout session.

For example: v1|2**********6|5**********4 or v1|1**********9|0.

For more information about item IDs for RESTful APIs, see Legacy API compatibility" }, "shippingOptionId": { "type": "string", "description": "A unique identifier of the selected shipping option/method." } }, "description": "A type that defines the fields used to update the shipping option of a line item." } }, "securitySchemes": { "api_auth": { "type": "oauth2", "description": "The security definitions for this API. Please check individual operations for applicable scopes.", "flows": { "clientCredentials": { "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": { "https://api.ebay.com/oauth/api_scope/buy.guest.order": "Purchase eBay items off eBay" } } } } } } }