eBay Trading APIVersion 1061

PickupInStoreDetailsType

Complex type defining the PickupInStoreDetails container, that is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup or Click and Collect.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. The Click and Collect feature is only available to large merchants on the UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

Types that use PickupInStoreDetailsType:

Calls that use PickupInStoreDetailsType:

Fields

EligibleForPickupDropOff ( boolean ) [0..1]
For 'Click and Collect' eligible sellers, this field was once used to set 'Click and Collect' eligibility at the listing level. However, now the seller can only opt in to 'Click and Collect' at the account level, and then each of their listings will be automatically evaluated for 'Click and Collect' eligibility.

Note: Until this field is fully deprecated in the Trading WSDL (and in Add/Revise/Relist/Verify calls), it can still be used, but it will have no functional affect. However, if set in an Add/Revise/Relist/Verify call, it will get returned in GetItem, but it won't be a true indicator if the item is available for the 'Click and Collect' logistics type. Instead, the Item.AvailableForPickupDropOff field should be referenced.
See the Field Index to learn which calls use EligibleForPickupDropOff.

EligibleForPickupInStore ( boolean ) [0..1]
This field is used in Add/Revise/Relist/Verify calls to enable the listing for In-Store Pickup. To enable the listing for In-Store Pickup, the seller includes this boolean field and sets its value to true. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multiple-quantity, fixed-price listings.

In addition to setting the EligibleForPickupInStore boolean field to true, the merchant must also perform the following actions in an Add/Revise/Relist/Verify call to enable the In-Store Pickup option on a multiple-quantity, fixed-price listing:
  • Have inventory for the product at one or more physical stores tied to the seller's account. By using the REST-based Inventory API, sellers can associate physical stores to their account by using the Create Inventory Location call, and then, using the Create Inventory Item call, they can add inventory to specific stores;
  • Include the seller-defined SKU value of the product(s) in the call request. For a single-variation listing, the SKU value would be specified in the Item.SKU field, and for a multiple-variation listing, the SKU value(s) would be specified in the Item.Variations.Variation.SKU field(s);
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to true;
    • Include only one Item.PaymentMethods field in the call request and set its value to 'PayPal;
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.
When a seller is successful at listing an item with the In-Store Pickup feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see the "Available for In-Store Pickup" option on the listing, along with information on the closest store that has the item.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multiple-quantity, fixed-price listings.
See the Field Index to learn which calls use EligibleForPickupInStore.