v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

Affiliate

Create a new affiliate for a customer.

Creates a new affiliate record for the given customer in this store. Requires the stores.affiliates.update permission.

post/stores/{storeId}/affiliates/{customerId}

storeIdstring uuid required

Store to create the affiliate in.

customerIdstring uuid required

Target customer ID.

isEnabledboolean nullable

Indicates whether the affiliate is active. If null, defaults to true when creating, or leaves unchanged when updating.

linkstring required

A link provided to affiliates for tracking and promotional purposes. Required and must not exceed 256 characters.

returnPercentageinteger nullable

The percentage of the order return the affiliate receives. If null, uses store’s default when creating, or leaves unchanged when updating.

percentageOffinteger nullable

The percentage discount offered by the affiliate link. If null, uses store’s default when creating, or leaves unchanged when updating.

balancenumber double nullable

The affiliate’s current balance. If null, defaults to zero when creating, or leaves unchanged when updating.

The object was successfully created.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error