order-api

name	order-api
description	Order API skill. Use when working with Order for guest_checkout_session, guest_purchase_order. Covers 8 endpoints.
version	1.0.0
generator	lapsh

Order API

API version: v2.1.2

Auth

OAuth2

Base URL

https://apix.ebay.com{basePath}

Setup

1. Configure auth: OAuth2
2. GET /guest_checkout_session/{checkoutSessionId} -- verify access
3. POST /guest_checkout_session/{checkoutSessionId}/apply_coupon -- create first apply_coupon

Endpoints

8 endpoints across 2 groups. See references/api-spec.lap for full details.

guest_checkout_session

Method	Path	Description
POST	/guest_checkout_session/{checkoutSessionId}/apply_coupon	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method adds a coupon to an eBay guest checkout session and applies it to all the eligible items in the order. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
GET	/guest_checkout_session/{checkoutSessionId}	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
POST	/guest_checkout_session/initiate	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method creates an eBay guest checkout session, which is the first step in performing a checkout. The method returns a checkoutSessionId that you use as a URI parameter in subsequent guest checkout methods. Note: This method also returns the X-EBAY-SECURITY-SIGNATURE response header, which is a token that is used to launch the Checkout with eBay widget. The Checkout with eBay widget allows eBay guests to pay for items without leaving your site. For details about the Checkout with eBay widget, see Integrating the Checkout with eBay button. Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs. TIP: To test the entire checkout flow, you might need a "test" credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
POST	/guest_checkout_session/{checkoutSessionId}/remove_coupon	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method removes a coupon from an eBay guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
POST	/guest_checkout_session/{checkoutSessionId}/update_quantity	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method changes the quantity of the specified line item in an eBay guest checkout session. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
POST	/guest_checkout_session/{checkoutSessionId}/update_shipping_address	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method changes the shipping address for the order in an eBay guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item. Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.
POST	/guest_checkout_session/{checkoutSessionId}/update_shipping_option	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method changes the shipping method for the specified line item in an eBay guest checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

guest_purchase_order

Method	Path	Description
GET	/guest_purchase_order/{purchaseOrderId}	Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API. Important! (Limited Release) This method is only available to select developers approved by business units. This method retrieves the details about a specific guest purchase order. It returns the line items, including purchase order status, dates created and modified, item quantity and listing data, payment and shipping information, and prices, taxes, discounts and credits. The purchaseOrderId is passed in as a URI parameter and is required. Note: The purchaseOrderId value is returned in the call-back URL that is sent through the new eBay pay widget. For more information about eBay managed payments and the new Order API payment flow, see Order API in the Buying Integration Guide. You can use this method to not only get the details of a purchase order, but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID. For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a apply_coupon?" -> POST /guest_checkout_session/{checkoutSessionId}/apply_coupon
• "Get guest_checkout_session details?" -> GET /guest_checkout_session/{checkoutSessionId}
• "Create a initiate?" -> POST /guest_checkout_session/initiate
• "Create a remove_coupon?" -> POST /guest_checkout_session/{checkoutSessionId}/remove_coupon
• "Create a update_quantity?" -> POST /guest_checkout_session/{checkoutSessionId}/update_quantity
• "Create a update_shipping_address?" -> POST /guest_checkout_session/{checkoutSessionId}/update_shipping_address
• "Create a update_shipping_option?" -> POST /guest_checkout_session/{checkoutSessionId}/update_shipping_option
• "Get guest_purchase_order details?" -> GET /guest_purchase_order/{purchaseOrderId}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP