Create a new product

post

https://megsapp-nova-stg.85.group/api/v1/products

Access: Auth methods: JWT bearer or API key. Allowed user types: MVNO, PARTNER. Requires permissions: product:write.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

vendorId

string

required

Vendor UUID

productTypeId

string

required

Product type UUID

categoryIds

array of strings

length ≤ 20

Product category UUIDs (max 20)

categoryIds

name

string

required

length ≤ 150

Product name

description

string

length ≤ 5000

Product description

appName

string

length ≤ 150

Title shown on the native app when set; otherwise the catalog name is used.

appDescription

string

length ≤ 5000

Description shown on the native app when set; otherwise catalog description is used.

ussdName

string

length ≤ 150

Short label for Echo when set; otherwise catalog name is used.

code

string

required

length ≤ 100

Unique product code

barcode

string

length ≤ 255

Product barcode/SKU

price

number

required

≥ 0

Product price

compareAtPrice

number

≥ 0

Compare-at (retail/RRP) price shown alongside price to indicate a discount

hasFlexibleAmount

boolean

Defaults to false

Whether product has flexible amount

activationFeeMinimum

number

Minimum activation fee (for flexible amount products)

activationFeeMaximum

number

Maximum activation fee (for flexible amount products)

activationFeeIncrements

number

Activation fee increments (for flexible amount products)

status

string

enum

Defaults to PENDING

Product status

Allowed:

channels

array of strings

Channels in which this product is surfaced. Empty array means no channels.

channels

Allowed:

starterPackId

string

Starter pack UUID this SIM SKU sells. Required for SIM_STARTER_PACK products and rejected for every other product type.

simType

string

enum

SIM family. Required for SIM_STARTER_PACK products and rejected for every other product type.

Allowed:

availableFrom

string

Product available from date

availableUntil

string

Product available until date

promoText

string

length ≤ 255

Promotional text

usageTextData

string

length ≤ 255

Data usage text

usageTextVoice

string

length ≤ 255

Voice usage text

usageTextSms

string

length ≤ 255

SMS usage text

logo

string

length ≤ 255

Product logo URL

sortOrder

number

Sort order

xeroItemCode

string

length ≤ 255

Xero item code

xeroGlCode

string

length ≤ 255

Xero GL code

mondayId

string

length ≤ 255

Monday.com ID

productKey

string

length ≤ 255

Product key for integrations

productValue

string

length ≤ 255

Product value for integrations

inAppExtra

boolean

Defaults to false

In-app extra flag

inAppExtraPercentage

number

0 to 100

In-app extra percentage

discounted

boolean

Defaults to false

Discounted product flag

expiry

boolean

Defaults to false

Product has expiry

expiryPeriod

number

Expiry period in days

expiryDate

string

Specific expiry date

Responses

201

Product created successfully

409

Product with this code already exists

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here!