Skip to main content

Commerce Extensions

Creating Custom APIs

  1. Go to COMMERCE EXTENSIONS > Custom APIs.
  2. Select Create New.
  3. Fill out the following details in the Basic Details section:
    1. In Name, enter the the name of the Custom API. It should be between 1 and 255 characters.
    2. In Description, enter the description for the Custom API.
  4. Fill out the following details in the Advanced Options section:
    1. In API Type, enter the type of the Custom API.
    2. In Slug, enter a unique slug identifier for the Custom API.
  5. Select Create Custom API.

Creating Custom Fields

To create a Custom Field for a Custom API, follow these steps:

  1. Go to COMMERCE EXTENSIONS > Custom APIs.
  2. Click on the target Custom API in the list.
  3. Select Create Field and choose one of the following options:
    • String
    • Integer
    • Boolean
  4. Fill out the following details in the Basic Details section:
    1. In Name, enter the name of the field for the Custom API. It should be between 1 and 255 characters.
    2. In Description, enter the description for the field.
    3. In Slug, enter a unique slug identifier for the field.
  5. Select Create Field.

Creating Custom API Entries

To create a Custom API Entry for a Custom API, follow these steps:

  1. Go to COMMERCE EXTENSIONS > Custom APIs.
  2. In the Actions column, click the button associated with the target Custom API and click View Entries option.
  3. Select Create Entry.
  4. Fill out the values for the configured Custom Fields as desired.
  5. Select Create Entry.