Skip to content

Exchange Variants (1.0.0)

The Exchange Variants API is what enables Exchanges. It is used to request a list of available product variants, typically items of the same style number, from your ecommerce platform when the shopper will be offered an opportunity to exchange a return item.

When it is used:

  • Optoro sends an Exchange Variants GET message to you when the shopper chooses a return reason that prompts the returns portal to show exchange options for an item that has an associated variant identifier.
Download OpenAPI description
Languages
Servers
Mock server
https://developer.optoro.com/_mock/openapi/variants/openapi

Exchange Variants

Request

Path
parent_skustringrequired
Headers
X-Optiturn-Idstringrequired
Example: Modrno
X-Optiturn-Api-Versionstringrequired
Value1
curl -i -X GET \
  'https://developer.optoro.com/_mock/openapi/variants/openapi/sku/{parent_sku}/variants' \
  -H 'X-Optiturn-Api-Version: 1' \
  -H 'X-Optiturn-Id: Modrno'

Responses

A list of product variants

Bodyapplication/json
variantsArray of objects(variant)

Array of product variants for the parent item.

Response
application/json
{ "variants": [ {} ] }