Sign in

v1

latestOpenAPI 3.0.02026-07-2335196124.2 KB
Product

Retrieve product info

Extract information about the products you configured for your account.

get/products/

Query parameters

Namestring

Product name. Can be NULL.

Typesstring

Array of the values representing the type of products. Possible values: REGULAR or BUNDLE. Leave empty to have all product types returned to the search.Can be NULL. If NULL, 2Checkout returns both regular and bundle products.

Enabledboolean

True or false. Can be NULL.

ReviewStatusboolean

Can be 'Does not exist', 'Pending', 'In Review', 'Passed' or 'Rejected'.

GroupNamestring

The name of the group that the product is associated with. Can be NULL.

Limitnumber

Number of results (products) displayed per page. Default value is 10. Can be NULL.

Pagenumber

A specific page of search results. Default value is 1. Can be NULL.

Headers

Accept'application/json' required
X-Avangate-Authenticationstring required

Authentication header

Response

OK

AvangateIdinteger nullable

Unique, system-generated product ID (read-only)

ProductCodestring

The unique product code you can define for each of your offerings

ExternalReferencestring

External reference set when defining the product

ProductType'REGULAR' | 'BUNDLE'

The type of the product (REGULAR or BUNDLE)

ProductNamestring

The name of the product

ProductVersionstring

The product version number

PurchaseMultipleUnitsboolean

Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product

GiftOptionboolean

True or false depending on whether the product can be gifted or not

ShortDescriptionstring

Product's short description

LongDescriptionstring

Product's long description

SystemRequirementsstring

System requirements

TrialUrlstring

The URL where shoppers can download trial software from

TrialDescriptionstring

Descriptive text entered for trials

Tangibleboolean

TRUE - for physical products, FALSE - for digital products

Enabledboolean

True/false depending on whether the products are active or disabled

ReviewProductUrlboolean

The URL where the product can be reviewed before approval. Required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation.

ReviewAdditionalDetailsboolean

Additional information can be added to access the review of the product. Parameter is optional.

Fulfillment'NO_DELIVERY' | 'INHERIT' | 'BY_AVANGATE' | 'BY_VENDOR'

Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY

GeneratesSubscriptionboolean

TRUE or FALSE depending on whether you set the product to generate subscriptions or not

All 35 operations