Connect to the 2Checkout Commerce API and Ecosystem.

Before you start using the 2Checkout API, make sure you are PCI DSS compliant. Find out more details about what PCI DSS compliance means and what you should do to be PCI compliant here.

Authentication

To authenticate to the 2Checkout REST API include a header with the following structure into your requests:

X-Avangate-Authentication: code={VENDOR_CODE} date={REQUEST_DATE_TIME} hash={HASH}

• VENDORCODE: Your unique 2Checkout supplied merchant code.

• REQUESTDATE_TIME: The UTC date time of the request. Format: YYYY-MM-DD HH:MM:SS. You must provide the time of the request in the GMT timezone.

• HA

  Contact Support: Name: No Contact Email: email@example.com

  1. productsku - Delete product SKU POST {{baseUrl}}/productsku/delete

  2. additionalfields-{Field Code} - Extract information about a specific additional field you set up for your account GET {{baseUrl}}/additionalfields/:FieldCode/

  3. productsku - Get product SKUs matching to parameters specified in request GET {{baseUrl}}/productsku/search?ProductCode=<string>&PricingConfigurations=<object>&PurchaseTypes=<array>

  4. affiliates - Search Affiliates GET {{baseUrl}}/affiliates?AffiliateCode=<string>&Name=<string>&Status=<string>&RequestDateStart=<string>&RequestDateEnd=<string>&Country=<string>&TargetCountry=<string>&CommissionList=<object>&Type=<string>&Page=<integer>&Limit=<integer>

  5. affiliates - Get Affiliate GET {{baseUrl}}/affiliates/:AffiliateCode

  6. additionalfields-{Field Code} - Extract additional field texts and translations. GET {{baseUrl}}/additionalfields/:FieldCode/translations/:ISOcode/

  7. additionalfields - Extract information about additional fields you set up for your account GET {{baseUrl}}/additionalfields/?Enabled=<boolean>&Required=<>&ApplyTo=<string>&Type=<string>

  8. crossselltexts - Working example: Retrieve cross-sell campaign texts GET {{baseUrl}}/crossselltexts/

  9. crossselltexts - Working example: Retrieve cross-sell campaign texts GET {{baseUrl}}/crossselltexts/:Language/

  10. customers-{C Reference} - Working example of how to retreive a customer GET {{baseUrl}}/customers/:CReference/