Open API V3 endpoint to retrieve a ListingProduct by ID.'
tags:
- ShopListing Product
parameters:
- name: listing_id
in: path
description: The listing to return a ListingProduct for.
required: true
schema:
type: integer
description: The listing to return a ListingProduct for.
format: int64
minimum: 1
example: 123456789
- name: product_id
in: path
description: The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
required: true
schema:
type: integer
description: The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
format: int64
minimum: 1
example: 567890123
- name: legacy
in: query
description: This parameter is needed to enable new parameters and response values related to processing profiles.
required: false
schema:
type: boolean
description: This parameter is needed to enable new parameters and response values related to processing profiles.
example: true
responses:
'200':
description: A single ListingInventoryProduct
content:
application/json:
schema:
$ref: '#/components/schemas/ListingInventoryProduct'
examples:
GetListingProduct200Example:
summary: Default getListingProduct 200 response
x-microcks-default: true
value:
product_id: 567890123
sku: SKU-12345
is_deleted: true
offerings:
- null
property_values:
- null
'404':
description: A resource could not be found. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
GetListingProduct404Example:
summary: Default getListingProduct 404 response
x-microcks-default: true
value:
error: example string
'400':
description: There was a problem with the request data. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
GetListingProduct400Example:
summary: Default getListingProduct 400 response
x-microcks-default: true
value:
error: example string
'401':
description: The request lacks valid authentication credentials. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
GetListingProduct401Example:
summary: Default getListingProduct 401 response
x-microcks-default: true
value:
error: example string
'500':
description: The server encountered an internal error. See the error message for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
examples:
GetListingProduct500Example:
summary: Default getListingProduct 500 response
x-microcks-default: true
value:
error: example string
security:
- api_key: []
oauth2:
- listings_r
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Etsy Get Listing Product
components:
schemas:
ErrorSchema:
type: object
x-resource-id: ErrorSchema
required:
- error
properties:
error:
type: string
example: example string
ListingPropertyValue:
type: object
x-resource-id: ListingPropertyValue
description: A representation of structured data values.
properties:
property_id:
type: integer
description: The numeric ID of the Property.
format: int64
minimum: 1
example: 1
property_name:
type: string
description: The name of the Property.
nullable: true
example: Handmade Ceramic Mug
scale_id:
type: integer
description: The numeric ID of the scale (if any).
format: int64
nullable: true
minimum: 1
example: 1
scale_name:
type: string
description: The label used to describe the chosen scale (if any).
nullable: true
example: Handmade Ceramic Mug
value_ids:
type: array
description: The numeric IDs of the Property values
items:
type: integer
format: int64
minimum: 1
values:
type: array
description: The Property values
items:
type: string
ListingInventoryProduct:
type: object
x-resource-id: ListingInventoryProduct
description: A representation of a product for a listing.
properties:
product_id:
type: integer
description: The numeric ID for a specific [product](/documentation/reference#tag/ShopListing-Product) purchased from a listing.
format: int64
minimum: 1
example: 567890123
sku:
type: string
description: The SKU string for the product
example: SKU-12345
is_deleted:
type: boolean
description: When true, someone deleted this product.
example: true
offerings:
type: array
description: A list of product offering entries for this product.
items:
description: A list of product offering entries for this product.
oneOf:
- $ref: '#/components/schemas/ListingInventoryProductOffering'
property_values:
type: array
description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
items:
description: 'A list of property value entries for this product. Note: parenthesis characters (`(` and `)`) are not allowed.'
oneOf:
- $ref: '#/components/schemas/ListingPropertyValue'
Money:
type: object
x-resource-id: Money
description: A representation of an amount of money.
properties:
amount:
type: integer
description: The amount of represented by this data.
example: 2500
divisor:
type: integer
description: The divisor to render the amount.
minimum: 0
example: 1
currency_code:
type: string
description: The ISO currency code for this data.
example: USD
ListingInventoryProductOffering:
type: object
x-resource-id: ListingInventoryProductOffering
description: A representation of an offering for a listing.
properties:
offering_id:
type: integer
description: The ID for the ProductOffering
format: int64
minimum: 1
example: 1
quantity:
type: integer
description: The quantity the ProductOffering
minimum: 0
example: 1
is_enabled:
type: boolean
description: Whether or not the offering can be shown to buyers.
example: true
is_deleted:
type: boolean
description: Whether or not the offering has been deleted.
example: true
price:
description: Price data for this ProductOffering
oneOf:
- $ref: '#/components/schemas/Money'
example: example
readiness_state_id:
type: integer
description: Processing Profile for this ProductOffering
format: int64
nullable: true
minimum: 1
example: 1
securitySchemes:
api_key:
type: apiKey
name: x-api-key
in: header
description: Every request to a v3 API endpoint must include this data in the format `keystring:shared_secret`. Your keystring and shared secret are available on the [Your Apps](https://www.etsy.com/developers/your-apps) page.
oauth2:
type: oauth2
description: Open API v3 supports authenticating via OAuth 2.0. More information about Etsy's specific implementation of OAuth2 can be found [here](/documentation/essentials/oauth2).
flows:
authorizationCode:
authorizationUrl: https://www.etsy.com/oauth/connect
tokenUrl: https://openapi.etsy.com/v3/public/oauth/token
scopes:
address_r: see billing and shipping addresses
address_w: update billing and shipping addresses
billing_r: see all billing statement data
cart_r: read shopping carts
cart_w: add/remove from shopping carts
email_r: read a user profile
favorites_r: see private favorites
favorites_w: add/remove favorites
feedback_r: see purchase info in feedback
listings_d: delete listings
listings_r: see all listings (including expired etc)
listings_w: create/edit listings
profile_r: see all profile data
profile_w: update user profile, avatar, etc
recommend_r: see recommended listings
recommend_w: accept/reject recommended listings
shops_r: see private shop info
shops_w: update shop
transactions_r: see all checkout/payment data
transactions_w: update receipts
x-tagGroups:
- name: Listing Management
tags:
- BuyerTaxonomy
- SellerTaxonomy
- ShopListing
- ShopListing File
- ShopListing Image
- ShopListing Inventory
- ShopListing Offering
- ShopListing Personalization
- ShopListing Product
- ShopListing Translation
- ShopListing VariationImage
- ShopListing Video
- name: Other
tags:
- Other
- name: Payment Management
tags:
- Ledger Entry
- Payment
- name: Receipt Management
tags:
- Shop Receipt
- Shop Receipt Transactions
- name: Review Management
tags:
- Review
- name: Shipping Management
tags:
- Shop HolidayPreferences
- Shop ProcessingProfiles
- Shop ShippingProfile
- name: Shop Management
tags:
- Shop
- Shop ProductionPartner
- Shop Section
- name: Shop Policy Management
tags:
- Shop Return Policy
- name: User Management
tags:
- User
- UserAddress