Exchange Variants (1.0.0)

Download OpenAPI specification:Download

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.

Exchange Variants

Request

path Parameters

parent_sku

required

string

header Parameters

X-Optiturn-Id required	string Example: Modrno
X-Optiturn-Api-Version required	string Value: 1

Responses

200

A list of product variants

get/sku/{parent_sku}/variants

Response samples

application/json

{"variants": [{"attributes": [{"name": "Color",
"value": "Green"
},
{"name": "Size",
"value": "XL"
}
],
"quantity_in_stock": 0,
"sku": "444-12345",
"title": "Fuzzy green t-shirt",
"unit_price_amount_cents": 100,
"image_url": "https://example.com/img.jpg",
"product_url": "https://example.com/fuzzy-green"
}
]
}