openapi: 3.0.0 info: title: Order API description: Note: This is the v1_beta version of the Order API which supports member checkout payment flows. If you need to support guest checkout payment flows, please use the v2 version of the Order API.

Note: This is a

(Limited Release) API available only to select developers approved by business units.

The Order API provides interfaces that let eBay members 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: v1_beta.37.0 servers: - url: https://apix.ebay.com{basePath} description: Production variables: basePath: default: /buy/order/v1 - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /buy/order/v1 paths: /checkout_session/{checkoutSessionId}/apply_coupon: post: tags: - checkout_session description: '

Important!(Limited Release) You must be whitelisted to use this method.

This method adds a coupon to an eBay 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.

Restrictions

Maximum: One coupon per order
For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

' operationId: applyCoupon 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: 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 - 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 requestBody: description: The container for the fields used to apply a coupon to a checkout session. content: application/json: schema: description: The container for the fields used to apply a coupon to a checkout session. $ref: '#/components/schemas/CouponRequest' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' '400': description: Bad Request 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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}. '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 '404': description: Resource Not Found '409': description: Conflict 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 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.order /checkout_session/{checkoutSessionId}: get: tags: - checkout_session description: '

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

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

' operationId: getCheckoutSession 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-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.

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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' 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 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 '404': description: Resource Not Found '409': description: Conflict 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 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.order /checkout_session/initiate: post: tags: - checkout_session description: This method creates an eBay member checkout session, which is the first step in performing a checkout. You use this method to create a checkout session before you can process a checkout. If the address submitted cannot be validated, a warning message will be returned.

The method returns a checkoutSessionId that you use as a URI parameter in subsequent checkout methods.

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.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview. operationId: initiateCheckoutSession parameters: - 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 - 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 requestBody: description: The container for the fields used by the initiateCheckoutSession method. content: application/json: schema: description: The container for the fields used by the initiateCheckoutSession method. $ref: '#/components/schemas/CreateSignInCheckoutSessionRequest' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' 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. '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 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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 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 quantity value is greater than the quantity available. Correct the quantity value and resubmit the call. '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. '15016': domain: API_ORDER category: BUSINESS description: The buyer is the seller of the item, which is not allowed. '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. '15024': domain: API_ORDER category: BUSINESS description: There is a problem with the buyer's payment method. Please check or provide another payment method for this order. '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. '15050': domain: API_ORDER category: BUSINESS description: Your transaction cannot be completed with the given information. Contact eBay customer service. '15051': domain: API_ORDER category: BUSINESS description: Additional user details required. Please complete your registration or contact eBay customer support. '15056': domain: API_ORDER category: BUSINESS description: The buyer is not the winning bidder of the auction. '17001': domain: API_ORDER category: BUSINESS description: Authentication with the payment provider failed. Please log into eBay.com and ensure payment provider accounts are properly linked. '20002': domain: API_ORDER category: BUSINESS description: This item {itemId} is currently unavailable to buy from the seller. '500': description: Internal Server 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.order /checkout_session/{checkoutSessionId}/place_order: post: tags: - checkout_session description: '

This method creates the purchase order, pays for the items, and terminates the specified eBay member checkout session. The checkoutSessionId is passed in as a URI parameter and is required. Although there is not a request payload, for this method you must pass in { } in the request body.

Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

Note: If the credit card is declined, the checkout session is unusable. You will need to create a new checkout session for the order using the initiateCheckoutSession method.

' operationId: placeOrder 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-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.

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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderSummary' x-response-codes: errors: '15005': domain: API_ORDER category: BUSINESS description: Some of the line items were not purchased. Use the Order API getPurchaseOrder call to check the payment status of each line item. '15006': domain: API_ORDER category: BUSINESS description: The order has already been placed for the checkout session submitted and no modifications can be made. Use the Order API getPurchaseOrder call to get the purchase order details. '400': description: Bad Request x-response-codes: errors: '15003': domain: API_ORDER category: REQUEST description: The checkout session requested does not exist. '15004': domain: API_ORDER category: REQUEST description: The buyer's credit card information is missing. Please submit the buyer's credit card information using updatePaymentInfo method. '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 '404': description: Resource Not Found '409': description: Conflict 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. '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. '15020': domain: API_ORDER category: BUSINESS description: During the checkout process the item has been changed. Create a new checkout session for this item using the initiateCheckoutSession call. '15023': domain: API_ORDER category: BUSINESS description: The payment cannot be processed due to an issue with the funding source, such as insufficient funds, or invalid payment details, such as card number or billing address error. To complete this order, use the appropriate initiate checkout session call to create a new session and either provide a new payment method or correct the payment details. '15024': domain: API_ORDER category: BUSINESS description: There is a problem with the buyer's payment method. Please check or provide another payment method for this order. '15027': domain: API_ORDER category: BUSINESS description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' '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. '17000': domain: API_ORDER category: BUSINESS description: The payment cannot be processed due to a payment processor issue, such as invalid incentive, funding or financing issue, etc '500': description: Internal Server 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.order /checkout_session/{checkoutSessionId}/remove_coupon: post: tags: - checkout_session description:

(Limited Release) You must be whitelisted to use this method.

This method removes a coupon from an eBay member 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.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

operationId: removeCoupon 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: 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 - 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 requestBody: description: The container for the fields used to remove a coupon from a checkout session. content: application/json: schema: description: The container for the fields used to remove a coupon from a checkout session. $ref: '#/components/schemas/CouponRequest' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' '400': description: Bad Request 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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}. '16025': domain: API_ORDER category: REQUEST description: The coupon was not applied to this cart. '403': description: Access Forbidden '404': description: Resource Not Found '409': description: Conflict 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 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.order /checkout_session/{checkoutSessionId}/update_add_on_services_status: post: tags: - checkout_session description: This method changes the selection of add-on services for one line item for the checkout session. operationId: updateAddonServicesStatus 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: 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 - 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 requestBody: description: The container for the fields used by the updateAddonServicesRequest method. content: application/json: schema: description: The container for the fields used by the updateAddonServicesRequest method. $ref: '#/components/schemas/UpdateAddonServicesRequest' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' x-response-codes: errors: '18000': domain: API_ORDER category: REQUEST description: '{serviceId} is not a valid add-on service for this item {lineItemId}. Correct the value and resubmit the call.' '18001': domain: API_ORDER category: APPLICATION description: The selected add-on service {serviceId} could not be added to the checkout session at this time. Please try again or process the checkout session without selecting the service. '18002': domain: API_ORDER category: APPLICATION description: Selected add-on service {serviceId} is no longer available. You can still process the checkout session without selecting the service. '18004': domain: API_ORDER category: APPLICATION description: Based on your add-on service selection(s), your shipping option and/or shipping price might have changed. Please check these values before proceeding with your order. '400': description: Bad Request 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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 '404': description: Resource Not Found '409': description: Conflict x-response-codes: errors: '15021': domain: API_ORDER category: BUSINESS description: This checkout session cannot be updated because the order has already been placed. '500': description: Internal Server 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. '18003': domain: API_ORDER category: APPLICATION description: Selected add-on service {fieldName} is not eligible for the shipping destination. '18005': domain: API_ORDER category: APPLICATION description: Selected add-on service {fieldName} is required for this purchase. security: - api_auth: - https://api.ebay.com/oauth/api_scope/buy.order /checkout_session/{checkoutSessionId}/update_payment_info: post: tags: - checkout_session description: '

This method changes the payment method information of the specified eBay member checkout session.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

' operationId: updatePaymentInfo 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: 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 - 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 requestBody: description: The container for the fields used by the updatePaymentInfo method. content: application/json: schema: description: The container for the fields used by the updatePaymentInfo method. $ref: '#/components/schemas/UpdatePaymentInformation' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' 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 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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}. '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 '404': description: Resource Not Found '409': description: Conflict x-response-codes: errors: '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. '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. '15022': domain: API_ORDER category: BUSINESS description: Some of the items cannot be purchased using a credit card and must be removed from the checkout session. '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 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.order /checkout_session/{checkoutSessionId}/update_quantity: post: tags: - checkout_session description: '

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

Note: This method is not applicable to auction item checkouts, as the quantity field must be 1. If this field is updated to any other value, an error will be returned.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

' operationId: updateQuantity 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: 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 - 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 requestBody: description: The container for the fields used by the updateQuantity method. content: application/json: schema: description: The container for the fields used by the updateQuantity method. $ref: '#/components/schemas/UpdateQuantity' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' '400': description: Bad Request 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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 '404': description: Resource Not Found '409': description: Conflict 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 quantity value is greater than the quantity available. Correct the quantity value and resubmit the call. '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}.' '500': description: Internal Server 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.order /checkout_session/{checkoutSessionId}/update_shipping_address: post: tags: - checkout_session description: '

This method changes the shipping address for in an eBay member 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.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

' operationId: updateShippingAddress 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: 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 - 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 requestBody: description: The container for the fields used by the updateShippingAddress method. content: application/json: schema: description: The container for the fields used by the updateShippingAddress method. $ref: '#/components/schemas/ShippingAddressImpl' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' 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 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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}. '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 '404': description: Resource Not Found '409': description: Conflict 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 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.order /checkout_session/{checkoutSessionId}/update_shipping_option: post: tags: - checkout_session description: '

This method changes the shipping method for the specified line item in an eBay member 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.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

' operationId: updateShippingOption 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: 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 - 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 requestBody: description: The container for the fields used by the updateShippingOption method. content: application/json: schema: description: The container for the fields used by the updateShippingOption method. $ref: '#/components/schemas/UpdateShippingOption' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionResponse' '400': description: Bad Request 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. This error can be returned due to multiple scenarios. Please refer to Order API error details for assistance on troubleshooting the issue.' '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 '404': description: Resource Not Found '409': description: Conflict 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 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.order /purchase_order/{purchaseOrderId}: get: tags: - purchase_order description: '

This method retrieves the details about a specific eBay member 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, and discounts and credits.

The purchaseOrderId is passed in as a URI parameter and is required. This method has no request payload.

The placeOrder method initiates the payment process, which can sometimes take a few minutes. 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.

This method also returns the legacyItemId, legacyTransactionId, and legacyOrderId fields. The values in these fields enable eBay partners to use the Post Order API for eBay member checkouts, to process a return or cancellation. For more information, see Post order tasks in the Buy Integration Guide.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

' operationId: getPurchaseOrder parameters: - name: purchaseOrderId in: path description: This path parameter specifies the unique identifier of a purchase order made by an eBay member, for which details are to be retrieved.

This value is returned by the placeOrder method in the purchaseOrderId field. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PurchaseOrder' '400': description: Bad Request 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 '404': description: Not Found '500': description: Internal Server 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.order.readonly - https://api.ebay.com/oauth/api_scope/buy.order servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /buy/order/v1 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. AddonServiceInput: type: object properties: selected: type: boolean description: This field is used to add or remove an add-on service for an order line item. Set the field value to true to add a service or false to remove it. serviceId: type: string description: 'The unique identifier of the add-on service.

This value appears in the response field lineitems.addonServices.serviceId of the getCheckoutSession method.

Note: BUYER_PROTECTION cannot be added or removed as a add-on service with this method. eBay adds this service automatically if applicable.' description: A type that defines which add-on services are selected for an item. This type is used by updateAddonServicesStatus to add an add-on service to an order line item. Adjustment: type: object properties: amount: description: The container for the amount and currency of the adjustment. $ref: '#/components/schemas/Amount' label: type: string description: Text that describes the adjustment. description: The type that defines the fields for seller adjustments. An adjustment can be a credit or debit. Amount: type: object properties: currency: type: string description: A three letter ISO 4217 code specifying the currency of the monetary amount. For implementation help, refer to eBay API documentation value: type: string description: The monetary amount. description: The type the defines the fields for the details of a monetary amount, in the currency used by the method and in the original currency, if the amount was converted between currencies. 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 verification inspection.
Note: This field is conditionally returned when there is information that applies to the Authenticity Guarantee program.' status: type: string description: 'The value in this field indicates whether the order line item has passed or failed the authenticity verification inspection, or if the inspection and/or results are still pending. The possible values returned here are PENDING, PASSED, FAILED, or INELIGIBLE.
Note: This field is conditionally returned when purchase is complete. For implementation help, refer to eBay API documentation' termsWebUrl: type: string description: The terms and conditions that apply to the Authenticity Guarantee program. description: This type is used to provide the status and outcome of an order line item going through the Authenticity Guarantee verification process. BillingAddress: type: object properties: addressLine1: type: string description: 'The first line of the street address.

Maximum characters

AU, CA, & US: 40
DE & GB: 35
All other marketplaces: 50

Note: For the EBAY_US - USA (ebay.com) marketplace, this is a 2 character value. For a list of these, see US State and Canada Province Codes. ' description: 'The type that defines the fields for an address. ' CheckoutAddonService: type: object properties: selected: type: boolean description: 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 ID 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. CheckoutSessionResponse: type: object properties: acceptedPaymentMethods: type: array description: 'The container that returns the payment methods that can be used to purchase the items. ' items: $ref: '#/components/schemas/PaymentMethod' appliedCoupons: type: array description: The container that returns the information of the coupons that were applied in the checkout session. items: $ref: '#/components/schemas/Coupon' checkoutSessionId: type: string description: The checkoutSessionId submitted in the request. expirationDate: type: string description: The time the checkout session will end. To purchase the items the order must be placed before this time. lineItems: type: array description: An array of line items associated with the checkout session. items: $ref: '#/components/schemas/LineItem' pricingSummary: description: The container that returns information about the costs of the order, such as the total cost, discounts, etc., of all the line items. $ref: '#/components/schemas/PricingSummary' providedPaymentInstrument: description: The container that returns the payment methods that can be used for the checkout. This is returned only if you have used the updatePaymentInfo method to change the payment method. $ref: '#/components/schemas/ProvidedPaymentInstrument' shippingAddress: description: 'The container that returns the address where the purchase order will be shipped. ' $ref: '#/components/schemas/ShippingAddress' taxDetails: type: array description: Detailed tax information for items included in this order. items: $ref: '#/components/schemas/TaxDetails' warnings: type: array description: An array of any process errors or warnings that were generated during the method processing. items: $ref: '#/components/schemas/Error' description: Type that defines the fields for a checkout session. Coupon: type: object properties: redemptionCode: type: string description: 'The redemption code of the coupon. Note: There can be only one redemption code per order.' description: The type that defines the fields for the coupon information.

Note: This container is not returned for the getPurchaseOrder and getGuestPurchaseOrder methods. CouponRequest: type: object properties: redemptionCode: type: string description: 'The redemption code of the coupon.

Maximum: one redemption code per order' description: The type that defines the fields for the coupon information used in the request. CreateSignInCheckoutSessionRequest: type: object properties: creditCard: description: The container that returns the buyer's credit card information. $ref: '#/components/schemas/CreditCard' lineItemInputs: type: array description: 'The container for the line item information fields in an eBay member checkout session.

Maximum number of line items: 10' items: $ref: '#/components/schemas/LineItemInput' shippingAddress: description: 'The container for the shipping address information in an eBay member checkout session. The Order API supports only domestic shipping. For example, an item purchased on the EBAY_DE marketplace can be shipped only to an address in Germany.

Note: If the address cannot be validated, a warning message is returned along with the response.' $ref: '#/components/schemas/ShippingAddress' description: The type that defines the fields for creating an eBay member checkout session. CreditCard: type: object properties: accountHolderName: type: string description: 'The name of the card holder under which the credit card was issued. ' billingAddress: description: 'The container that returns the billing address of the card holder.

Note: If the address cannot be validated, a warning message will be returned. ' $ref: '#/components/schemas/BillingAddress' brand: type: string description: The type of the credit card, such as Visa or MasterCard.

For a list of valid values, see PaymentMethodBrandEnum. cardNumber: type: string description: 'The credit card number on the card. ' cvvNumber: type: string description: 'The Card Verification Value of the credit card. This value is also known as the card verification code (CVC) or card security code (CSC).

This is a three-digit number on VISA, MasterCard, and Discover branded credit and debit cards. On American Express branded cards, this is a four-digit numeric code.

Note: This number is not the PIN associated with the card. ' expireMonth: type: integer description: The month the credit card expires. format: int32 expireYear: type: integer description: The year the credit card expires. format: int32 description: 'The type that defines the fields for the credit card that''s used to pay for the items. ' Error: type: object properties: category: type: string description: Identifies the type of error. domain: type: string description: Name for the primary system where the error occurred. This is relevant for application errors. errorId: type: integer description: A unique number to identify the error. format: int32 inputRefIds: type: array description: An array of request elements most closely associated to the error. items: type: string longMessage: type: string description: A more detailed explanation of the error. message: type: string description: Information on how to correct the problem, in the end user's terms and language where applicable. outputRefIds: type: array description: An array of request elements most closely associated to the error. items: type: string parameters: type: array description: An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. items: $ref: '#/components/schemas/ErrorParameter' subdomain: type: string description: 'Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.' description: The type that defines the fields for the error messages. ErrorParameter: type: object properties: name: type: string description: The object of the error. value: type: string description: The value of the object. description: An array of name/value pairs that provide details regarding the error. EventLocation: type: object properties: city: type: string description: 'The city where the tracking event occurred. ' country: type: string description: The two letter code representing the country of the address where the tracking event occurred. For implementation help, refer to eBay API documentation county: type: string description: The county where the tracking event occurred. postalCode: type: string description: The postal code where the tracking event occurred. stateOrProvince: type: string description: The state where the tracking event occurred. description: The type that defines the fields for the location of a tracking event. Fee: type: object properties: amount: description: A container for the currency type and monetary amount of the fees 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 applicable to the line item. Image: type: object properties: height: type: integer description: ' Reserved for future use. ' format: int32 imageUrl: type: string description: The URL of the image. width: type: integer description: ' Reserved for future use. ' format: int32 description: The type the defines the fields for the details of an image, such as size and URL. Currently only imageUrl is getting populated. The height and width were added for future use. 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: This enumeration value indicates the type of import tax applicable to the order. Currently, the only import tax is Goods and Services Tax (indicated by GST) which applies only to Australia and New Zealand where GST is charged to buyers outside of these two countries.

Note: Canada also charges a Goods and Services Tax. However, in this case, GST does not represent an import tax, but rather a Federal Sales Tax that is charged on most items sold. ImportTax will not be returned for Canadian sales transactions. For implementation help, refer to eBay API documentation description: This type provides 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. 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. 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. description: The type that defines the fields to support using the Post Order API for returns and cancellations. 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: This container is 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 item in this line item. This is the starting point for computing the price during 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. eBay assigns the URL when the seller uploads the image. $ref: '#/components/schemas/Image' importDuties: description: 'The total amount of import duties for this line item, which is paid by the buyer when checking out.

Note: This is applicable only for eBay International Shipping (eIS) orders, and eIS is only available to sellers on US marketplace.

For GSP orders, the import charges will be shown in the shippingOptions.importCharges container.' $ref: '#/components/schemas/Amount' itemId: type: string description: 'The eBay 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 ID for RESTful APIs, see the Legacy API compatibility.

Each itemId will become a single line item. You can have a maximum of 10 itemId(s) per checkout.' 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 items in this line item taking into account the quantity and applying any seller item discounts, such as Buy 1 Get 1, and any coupon that applies to this item.

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 item of this line item. items: $ref: '#/components/schemas/Promotion' quantity: type: integer description: The number of individual items ordered for this line item.

Note: If a winning bidder is purchasing an auction item, the value of the this field will be returned as 1. format: int32 seller: description: The 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 the shipping methods that are available for the line item. By default, the first one will be selected. items: $ref: '#/components/schemas/ShippingOption' shortDescription: type: string description: This text string is derived from the item condition, item title, and the item aspects (such as size, color, capacity, model, brand, etc.). 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: The type that defines the fields for an individual line item. LineItemInput: type: object properties: itemId: type: string description: 'The eBay 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 ID for RESTful APIs, see the Legacy API compatibility.

Each itemId will become a single line item. You can have a maximum of 10 itemId(s) per checkout.' quantity: type: integer description: The quantiy order of the line item.

Note: If a winning bidder is purchasing an auction item, the value of the this field must be 1 or an error will be returned. format: int32 description: The type that defines the fields for a line item. LineItemReference: type: object properties: lineItemId: type: string description: A unique eBay-assigned ID value to identify the line item in a purchase order. quantity: type: integer description: The number of individual items ordered for this line item, as specified by the buyer. format: int32 description: Type the defines the fields for the line item ID and the quantity. OrderLineItem: 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: This container 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 item in this 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: The URL of the item's image. $ref: '#/components/schemas/Image' itemId: type: string description: The identifier of the item. 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: The 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. $ref: '#/components/schemas/LegacyReference' lineItemId: type: string description: The identifier of this line item. This is created by the initiateCheckoutSession for a member and initiateGuestCheckoutSession for a guest calls. lineItemPaymentStatus: type: string description: An enumeration value that indicates the payment status of this 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, this status will never change from FULFILLMENT_IN_PROGRESS because without tracking information eBay has no way of knowing if the order was delivered. For implementation help, refer to eBay API documentation' netPrice: description: 'The total cost for the items in this line item taking into account the quantity and applying any seller item discounts, such as Buy 1 Get 1, and any coupon that applies to this item.

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

Maximum Length: 40 characters promotions: type: array description: An array of promotions applied to the items in this line item. items: $ref: '#/components/schemas/Promotion' quantity: type: integer description: The number of individual items in this line item. format: int32 seller: description: The container for information about the seller offering this item, such as the seller's user name. $ref: '#/components/schemas/Seller' shippingDetail: description: Information about the shipping provider used for this line item. $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: The type that defines the fields for line item information in a purchase order. PaymentInstrument: type: object properties: brand: description: The name of the credit card company (brand). $ref: '#/components/schemas/PaymentMethodBrand' paymentMethodType: type: string description: An enumeration value that indicates the method of payment, such as credit card. For implementation help, refer to eBay API documentation description: The type that defines the fields for the reference information about the payment method. PaymentInstrumentReference: type: object properties: externalReferenceId: type: string description: This field is deprecated. lastFourDigitForCreditCard: type: string description: The last four digits of the credit card number being used to pay for the items. description: The type that defines the fields for the payment reference, such as last four digits of a credit card. PaymentMethod: type: object properties: label: type: string description: Text indicating the payment type. Credit card is the only accepted payment method for Order v1. Therefore, this value will always be CC. logoImage: description: The URL of the image of the payment method logo. $ref: '#/components/schemas/Image' paymentMethodBrands: type: array description: An array of credit card brands that can be used as the payment method. items: $ref: '#/components/schemas/PaymentMethodBrand' paymentMethodMessages: type: array description: The type that defines the fields for legal messages and buyer consent verification. items: $ref: '#/components/schemas/PaymentMethodMessage' paymentMethodType: type: string description: An enumeration value that indicates the method of payment, such as credit card. For implementation help, refer to eBay API documentation description: The type that defines the fields for the payment method. PaymentMethodBrand: type: object properties: logoImage: description: The URL of the image of the credit card company (brand). $ref: '#/components/schemas/Image' paymentMethodBrandType: type: string description: An enumeration value that indicates the credit card company (brand). For implementation help, refer to eBay API documentation description: The type that defines the fields for the credit card company (brand), which can be used as the payment method. PaymentMethodMessage: type: object properties: legalMessage: type: string description: 'Information that eBay is legally obligated to show to the buyer. This field can be null, in which case do nothing. But if this field is not null, the value of this field must appear on the checkout page.

Note: This field is not used for US purchases.' privacyPolicyWebUrl: type: string description: 'Reserved for future use. ' requiredForUserConfirmation: type: boolean description: 'Reserved for future use. ' userAgreementWebUrl: type: string description: 'Reserved for future use. ' description: The type that defines the fields for legal messages and buyer consent verification. PricingSummary: type: object properties: additionalSavings: description: The total amount of the coupon discounts in the purchase order. $ref: '#/components/schemas/Amount' addonServiceFee: 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 purchase order that are not already captured in one of the other fields. $ref: '#/components/schemas/Adjustment' deliveryCost: description: 'The shipping cost for all of the line items after any shipping discounts are applied.

Let''s say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryCost value would be $15, which is the total cost for shipping all of the line items after the discount is appiled.

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 shipping discounts for all of the line items, such as free shipping.

Let''s say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryDiscounts value would be 5, which is the value of the free shipping discount.

Note: This will always be a negative number.' $ref: '#/components/schemas/Amount' fee: description: The total amount of any fees for all the line items, such as a recycling fee. $ref: '#/components/schemas/Amount' importCharges: description: The sum of the Global Shipping Program import charges for all line items. $ref: '#/components/schemas/Amount' importTax: description: This container provides 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 amount of all the item discounts for all line items, such as Buy 1 Get 1 free.

Let''s say there were 4 line items. One of the line items qualifies for free shipping, which is $5 and two items qualify for a Buy 1 Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value would be 21, which is the total of the two Buy 1 Get 1 discounts. The shipping discount is not included. It is returned in the deliveryDiscount field.

Note: This will always be a negative number.' $ref: '#/components/schemas/Amount' priceSubtotal: description: 'The total amount for all the line items taking into account the item quantity but before adding in taxes and shipping costs, or applying discounts, fees, and adjustments.

Note: This price does not include the value-added tax (VAT) collected in applicable jurisdictions. For more information on VAT, refer to VAT Obligations in the EU.' $ref: '#/components/schemas/Amount' tax: description: The total amount of the taxes for all the line items. $ref: '#/components/schemas/Amount' total: description: 'The total of the purchase order.

total = priceSubtotal + baseDeliveryCost + tax + importCharges + deliveryDiscounts + priceDiscount + adjustment.

Note: deliveryDiscounts and priceDiscount are negative numbers.' $ref: '#/components/schemas/Amount' description: The type that defines the fields for the costs, discounts, and seller fees and adjustments of all the line items. Promotion: type: object properties: discount: description: The discount amount on the applied promotional offer. $ref: '#/components/schemas/Amount' discountPercentage: type: string description: 'Note: This field is not return in the purchase order methods response. ' message: type: string description: The text for the promotion title, which describes the promotion. For example, Buy 1 Get 1. promotionCode: type: string description: An identifier of the promotion that was generated by the system when the promotion was created.

Note: No data is returned in this field for the getPurchaseOrder and getGuestPurchaseOrder methods. promotionType: type: string description: 'Indicates the kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON.' description: The type that defines the fields for the details of an item promotion. ProvidedPaymentInstrument: type: object properties: paymentInstrumentReference: description: The container that returns the payment reference, such as last four digits of a credit card. $ref: '#/components/schemas/PaymentInstrumentReference' paymentMethodBrand: description: The container that returns the name and logo of the payment company (brand), such as Visa. $ref: '#/components/schemas/PaymentMethodBrand' paymentMethodType: type: string description: An enumeration value that indicates the method of payment, such as CREDIT_CARD. For implementation help, refer to eBay API documentation description: The type that defines the fields for reference information about the payment method. This is returned only if you have used the updatePaymentInfo method to change the payment method. PurchaseOrder: type: object properties: appliedCoupons: type: array description: The container that returns the information for the coupons that were applied in the order.

Note: This container is not returned for the getPurchaseOrder and getGuestPurchaseOrder methods. items: $ref: '#/components/schemas/Coupon' lineItems: type: array description: An array of line items in the purchase order. items: $ref: '#/components/schemas/OrderLineItem' paymentInstrument: description: 'The payment method used for the purchase order. ' $ref: '#/components/schemas/PaymentInstrument' pricingSummary: description: The container that returns the monetary details of the order. $ref: '#/components/schemas/PricingSummary' purchaseOrderCreationDate: type: string description: The timestamp of when the purchase order was created. purchaseOrderId: type: string description: The unique identifier of the purchase order. This value was returned in the purchaseOrderId field by the placeOrder method. purchaseOrderPaymentStatus: type: string description: An enumeration value that indicates the status of the payment for the purchase order. For implementation help, refer to eBay API documentation purchaseOrderStatus: type: string description: The container for 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 purchaseOrderWebUrl: type: string description: The URL to the Order Details page on eBay. refundedAmount: description: The total amount of any refunds for purchase order. $ref: '#/components/schemas/Amount' shippingAddress: description: The shipping address for the purchase order. $ref: '#/components/schemas/ShippingAddress' shippingFulfillments: type: array description: An array of the shipping providers and the purchase order delivery details. items: $ref: '#/components/schemas/ShippingFulfillment' taxDetails: type: array description: Detailed tax information for items included in this order. items: $ref: '#/components/schemas/TaxDetails' warnings: type: array description: An array of warning messages. These type of errors do not prevent the call from executing but should be checked. items: $ref: '#/components/schemas/Error' description: The type that defines the fields for a purchase order, including line items, costs and charges, payment method, and the purchase order status. PurchaseOrderSummary: type: object properties: purchaseOrderHref: type: string description: The URI of the purchase order. purchaseOrderId: type: string description: 'A unique identifier of the purchase order. When a checkout session completes, a purchase order ID is generated but this does not indicate that the item has been paid for.

Note: If there is a problem with the payment information, the purchase order ID will be returned and the PurchaseOrderPaymentStatusEnum field will return FAILED.' purchaseOrderPaymentStatus: type: string description: An enumeration value that indicates the payment status for the purchase order. For implementation help, refer to eBay API documentation warnings: type: array description: An array of warning messages. items: $ref: '#/components/schemas/Error' description: The type that defines the fields for the summary of a 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:

STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.
COUNTRY - Indicates the region is a single country.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' description: This type is used to provide region details for a tax jurisdiction. Seller: type: object properties: feedbackPercentage: type: string description: The percentage of the total positive feedback. feedbackScore: type: integer description: The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. format: int32 sellerAccountType: type: string description: 'Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in some countries.

This field is returned only on the following sites.

EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL

Valid values:

BUSINESS
INDIVIDUAL

Code so that your app gracefully handles any future changes to this list. ' username: type: string description: The user name created by the seller for use on eBay. description: The type that defines the fields for the basic seller information. ShipmentTrackingEvents: type: object properties: description: type: string description: 'A string describing the tracking event.

For example: On FedEx vehicle for delivery' eventDate: type: string description: 'The date of the shipment tracking event.

UTC Format: yyyy-MM-ddThh:00:00.000Z

For example: 2019-03-01T12:12:00.000Z' eventType: type: string description: 'A normalized string for shipment tracking event.

For example: OUT_FOR_DELIVERY' location: description: 'Where the shipment tracking event occurred.

For example: The city, state, postal code, and country of where the package was delivered.' $ref: '#/components/schemas/EventLocation' description: The type that defines the fields for the details of a shipping event, such as DELIVERED. ShippingAddress: type: object properties: addressLine1: type: string description: The first line of the street address where the item is being shipped. 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'. 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. postalCode: type: string description: The postal code of the address where the item is being shipped. recipient: type: string description: Name of the person receiving the package. stateOrProvince: type: string description: The state or province of the address where the item is being shipped. description: The type that defines the fields for a shipping address. For restrictions, see Shipping restrictions. ShippingAddressImpl: type: object properties: addressLine1: type: string description: 'The first line of the street address.

Maximun characters:

AU, CA, & US: 40
DE & GB: 35
All other marketplaces: 50

' 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'. city: type: string description: The city of the address. 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. 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. recipient: type: string description: Full name of the person receiving the purchase order. stateOrProvince: type: string description: 'The state or province of the address.

Note: For the US marketplace, this is a 2 character value. For a list of these, see US State and Canada Province Codes. ' description: 'The type that defines the shipping address fields.

Note: If the address cannot be validated, a warning message is be returned along with the response.' ShippingDetail: type: object properties: ebayShipping: type: boolean description: This indicates the shipping cost of the authenticated item, which the buyer paid 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, such as FedEx, or USPS for the line item. shippingServiceCode: type: string description: A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). description: The type that defines the fields for the shipping information, such as delivery date estimates and shipping provider. ShippingFulfillment: type: object properties: actualDeliveryDate: type: string description: The date the purchase order was delivered. lineItemReferences: type: array description: The container the returns the fields for the line item ID and the quantity. items: $ref: '#/components/schemas/LineItemReference' 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. shipmentTrackingEvents: type: array description: The container that returns all the shipment tracking events. items: $ref: '#/components/schemas/ShipmentTrackingEvents' shipmentTrackingNumber: type: string description: The shipping provider number associated with the purchase order that can be used to track the package. shipmentTrackingUrl: type: string description: The URL of the shipping provider's shipment tracking page. shippedDate: type: string description: The date the seller gave the purchase order to the shipping provider. shippingCarrierCode: type: string description: A name of the shipping provider, such as FedEx, or USPS. shippingServiceCode: type: string description: A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). description: The type that defines the fields for the shipping details. ShippingOption: type: object properties: baseDeliveryCost: description: 'The shipping cost using this shipping option, for this line item, before any shipping 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 discount. ' $ref: '#/components/schemas/Amount' ebayShipping: type: boolean description: This indicates the shipping cost of the authenticated item. The cost of the shipping will be paid to eBay. importCharges: description: 'The Global Shipping Program import charges for for this line item.

Note: US sellers are transitioning from GSP to eBay International Shipping (eIS), and for any seller already transitioned to eIS, import charges will be shown in the ImportDuties container instead.' $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: Indicates if the shipping method is selected. shippingCarrierCode: type: string description: The shipping provider, such as FedEx, or USPS for the line item. shippingOptionId: type: string description: A unique ID for the selected shipping option/method. shippingServiceCode: type: string description: A name of a shipping type. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). description: The 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: 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.

Note: The information in these fields is only returned when requested from the GB marketplace, when applicable.' 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: 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. UpdateAddonServicesRequest: type: object properties: addonServices: type: array description: An array of add-on services for the line item specified in the lineItemId field. items: $ref: '#/components/schemas/AddonServiceInput' lineItemId: type: string description: The unique identifier that identifies a line item in a checkout session. description: The type that defines the add-on services in the request. UpdatePaymentInformation: type: object properties: creditCard: description: Container for the buyer's credit card information. $ref: '#/components/schemas/CreditCard' description: The type that defines the fields for payment information. UpdateQuantity: type: object properties: lineItemId: type: string description: A unique eBay-assigned ID value that identifies a line item in a purchase order. quantity: type: integer description: The number of individual items ordered in this line item, as specified by the buyer. format: int32 description: The 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. shippingOptionId: type: string description: 'A unique ID for the selected shipping option/method.

Note: A list of valid shipping option IDs for a given line item can be retrieved using the getCheckoutSession or initiateCheckoutSession method.' description: The 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: authorizationCode: authorizationUrl: https://auth.ebay.com/oauth2/authorize tokenUrl: https://api.ebay.com/identity/v1/oauth2/token scopes: https://api.ebay.com/oauth/api_scope/buy.order: View and manage your purchases https://api.ebay.com/oauth/api_scope/buy.order.readonly: View your order details