Bulk create products
Creates multiple products in a single request. Accepts up to 20 products and returns lists of successful and failed creations with detailed error reasons.
POST
/api/v1/{team_slug}/{app_slug}/products/bulkAuthorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
app_slugstringrequiredApp slug
team_slugstringrequiredTeam slug
Request body
requiredapplication/jsonProducts data
productsinternal_pkg_webserver_v1.CreateProductPayload[]requiredmax items 20
Show propertiesHide properties
Array of
internal_pkg_webserver_v1.CreateProductPayloadbrand_idstringBrand or series of a brand connected to product
customobjectCustom fields
descriptionstringDeprecated: read-only in write payloads. Derived from html_description.
exclude_from_feedsbooleanWhenever a product should exist in feeds or not. Default false
html_descriptionstringHTML description of the description fields. All of the fields which is not related to showing content, e.g <button> or <script> tags will be stripped from the input
html_short_descriptionstringHTML Shortdescription of the description fields. All of the fields which is not related to showing content, e.g <button> or <script> tags will be stripped from the input
market_statusinternal_pkg_webserver_v1.ProductMarketStatus[]Show propertiesHide properties
Array of
internal_pkg_webserver_v1.ProductMarketStatusmarket_idstringrequiredstatusstringrequiredAllowed:
activeinactivedraftincompletearchivedstore_group_idstringrequiredmeta_descriptionstringMeta description for SEO
meta_titlestringMeta title for SEO
package_dimensionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.DimensionsThe package dimensions
Show propertiesHide properties
capacity_milliliterintegerthe capacity in milliliter
min 0
depthintegerThe products depth in millimeter
min 0
diameterintegerthe products diameter in millimeter
min 0
heightintegerThe products height in millimeter
min 0
lengthintegerThe products length in millimeter
min 0
weightintegerThe products weight in grams
min 0
widthintegerThe products width in millimeter
min 0
product_dimensionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.DimensionsThe products dimensions
Show propertiesHide properties
capacity_milliliterintegerthe capacity in milliliter
min 0
depthintegerThe products depth in millimeter
min 0
diameterintegerthe products diameter in millimeter
min 0
heightintegerThe products height in millimeter
min 0
lengthintegerThe products length in millimeter
min 0
weightintegerThe products weight in grams
min 0
widthintegerThe products width in millimeter
min 0
product_namestringrequiredName of the product
product_numberstringrequiredProduct number
product_typestringProduct type. Default 'simple'
Allowed:
flexiblesimpleshort_descriptionstringDeprecated: read-only in write payloads. Derived from html_short_description.
slugstringSlug for the product
statusstringrequiredStatus of the product
Allowed:
activedraftinactivearchivedtax_group_slugstringrequiredThe tax group related to the product
Responses
201
Products created successfully
datainternal_pkg_webserver_v1.BulkCreateProductsResponserequiredShow propertiesHide properties
failedinternal_pkg_webserver_v1.BulkCreateFailedCreation[] | nullShow propertiesHide properties
Array of
internal_pkg_webserver_v1.BulkCreateFailedCreationproduct_numberstringreasonstringsuccessfulgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Product[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Productattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullProduct attributes
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Attributecreated_atstringdescriptionstring | nullfilterableboolean | nullidstringkeystringnamestring | nulltemplate_keystringtemplate_namestringtranslatableboolean | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslationsShow propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]updated_atstring | nullvaluesobject | nullbrandgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductBrand | nullBrand of the product
Show propertiesHide properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductBrand
addressgithub_com_enadhq_nabbit_internal_pkg_webserver_models.BrandAddressShow propertiesHide properties
citystringco_addressstringcountrystringhouse_numberstringpostal_codestringstate_provincestringstreet_addressstringemailstringidstringnamestringseriesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductSeries | nullShow propertiesHide properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductSeries
idstringnamestringslugstringnull
nullslugstringnull
nullcategoriesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductCategory[] | nullAssociated categories
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductCategoryattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullchildrengithub_com_enadhq_nabbit_internal_pkg_webserver_models.Category[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Categoryattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullchildrengithub_com_enadhq_nabbit_internal_pkg_webserver_models.Category[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.CategoryCircular reference to
github_com_enadhq_nabbit_internal_pkg_webserver_models.Category.cover_urlstringcreated_atstringdescriptionstringgoogle_product_category_idstring | nullidstringnamestringparent_idstringredirectsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects[] | nullseogithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO | nullShow propertiesHide properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO
github_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEOnull
nullslugstringsort_orderintegerstatusstringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategoryTranslationsupdated_atstring | nulluristring | nullcover_urlstringcreated_atstringdescriptionstringgoogle_product_category_idstring | nullidstringis_main_categorybooleannamestringorderintegerparent_idstringredirectsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects[] | nullseogithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO | nullShow propertiesHide properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO
meta_descriptionstringmeta_titlestringnull
nullslugstringsort_orderintegerstatusstringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategoryTranslationsShow propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]meta_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]meta_titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullsluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullupdated_atstring | nulluristring | nullchannel_statusesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductChannelStatus[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductChannelStatuschannel_idstringchannel_slugstringstatusstringcollectionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductCollection[] | nullAssociated collections
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductCollectionchildrengithub_com_enadhq_nabbit_internal_pkg_webserver_models.Collection[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Collectionchildrengithub_com_enadhq_nabbit_internal_pkg_webserver_models.Collection[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.CollectionCircular reference to
github_com_enadhq_nabbit_internal_pkg_webserver_models.Collection.created_atstringidstringparent_idstring | nullredirectsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects[] | nullslugstringrequiredstatusstringrequiredAllowed:
activeinactivedrafttitlestringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CollectionTranslationupdated_atstring | nulluristringcreated_atstringidstringorderintegerparent_idstring | nullredirectsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects[] | nullslugstringrequiredstatusstringrequiredAllowed:
activeinactivedrafttitlestringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CollectionTranslationShow propertiesHide properties
sluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nulltitlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullupdated_atstring | nulluristringcreated_atstringCreation timestamp
customobject | nulldescriptionstringDescription of the product
exclude_from_feedsbooleanIf the products should exist in feeds or not
filesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.File[] | nullProduct files
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Fileattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullcreated_atstringfolder_idstringidstringpublicbooleantitlestring | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.FileTranslationShow propertiesHide properties
titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nulltypegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nulltypestring | nullupdated_atstring | nullurlstringhtml_descriptionstringHtml description
html_short_descriptionstringHtml short description
idstringProduct ID
imagesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority[] | nullImages of the product
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriorityaltstring | nullapp_idstring | nullattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullblurhashstringcopyrightstring | nullcustomobject | nullfolder_idstringidstringparent_idstring | nullpriorityintegerpublicbooleanstatusstringtitlestring | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageTranslationShow propertiesHide properties
altgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullcopyrightgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nulltitlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullurlstringmarket_statusgithub_com_enadhq_nabbit_internal_pkg_webserver_models.MarketStatus[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.MarketStatuscreated_atstringmarket_idstringmarket_slugstringstatusstringstore_group_idstringstore_group_slugstringupdated_atstring | nullmarketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | nullAssociated markets
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Marketactivebooleancountry_codesstring[] | nullcreated_atstringcurrency_codestringidstringlocalestringnamestringslugstringupdated_atstring | nullmeta_descriptionstringMeta description for SEO
meta_titlestringMeta title for SEO
package_dimensionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.DimensionsThe package dimensions
Show propertiesHide properties
capacity_milliliterintegerthe capacity in milliliter
min 0
depthintegerThe products depth in millimeter
min 0
diameterintegerthe products diameter in millimeter
min 0
heightintegerThe products height in millimeter
min 0
lengthintegerThe products length in millimeter
min 0
weightintegerThe products weight in grams
min 0
widthintegerThe products width in millimeter
min 0
product_dimensionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.DimensionsThe products dimensions
product_namestringVariantName of the product
product_numberstringProduct number
product_typestringProduct type
redirectsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects[] | nullProduct redirects
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Redirectsidstringitem_idstring | nulllocalestringnew_slugstringold_slugstringtypegithub_com_enadhq_nabbit_internal_pkg_webserver_models.RedirectTypeAllowed:
productpagecollectioncategoryproduct_bundlerelationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Relation[]Product relations
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Relationdirectionstringidstringprimary_product_idstringproductsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.RelationProduct[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.RelationProductdescriptionstringidstringimage_urlstringproduct_namestringproduct_numberstringslugstringtitlestringtypestringtype_idstringschedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Jobadd_category_namesstring[]add_collection_namesstring[]add_tag_namesstring[]execute_atstringDate when the job should run
finished_atstring | nullIf a job is finished will this timestamp be filled
group_idstringidstringitem_idstringitem_namestringitem_typestringremove_category_namesstring[]remove_collection_namesstring[]remove_tag_namesstring[]to_amount_cents_with_taxinteger | nullto_market_idstringto_market_statusstringto_on_saleboolean | nullto_sale_amount_cents_with_taxinteger | nullto_start_sale_timestampstringto_statusstring | nullto_stop_sale_timestampstringto_store_group_idstringshort_descriptionstringShort description of the product
slugstringSlug for the product
statusstringStatus of the product
tagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductTag[] | nullProduct tags
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductTagattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullcreated_atstringfilterablebooleanidstringkeystringmarketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | nullnamestringorderintegerschedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | nullstatusstringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.TagTranslationsShow propertiesHide properties
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]updated_atstring | nulltax_group_idstring | nullThe id of the tax group
third_part_linksgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ThirdPartyLink[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ThirdPartyLinkcreated_atstringidstringtitlestringtypestringupdated_atstringurlstringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductTranslationsProduct translations
Show propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Translationidstringlocalestringvaluestringhtml_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullhtml_short_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullmeta_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullmeta_titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullnamegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullshort_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullsluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullupdated_atstring | nullLast updated timestamp
variant_groupsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroup[] | nullVariant groups with images, attributes, videos
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupAttribute[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupAttributeattribute_idstringattribute_keystringattribute_namestringtemplate_keystringtemplate_namestringchannel_statusesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupChannelStatus[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupChannelStatuschannel_idstringchannel_slugstringstatusstringcreated_atstringdescriptionstringidstringimagesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority[] | nullnamestringpriorityintegerproduct_idstringslugstringtagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductTag[] | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupTranslationsShow propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullnamegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullsluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullupdated_atstring | nullvariantsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupVariant[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupVariantidstringstatusstringvariant_namestringvariant_numberstringvideosgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Video[] | nullvariantsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Variant[] | nullProduct variants
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Variantattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullcreated_atstringcustom_fieldsobject | nullidstringimagesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority[] | nullImages of the product
listingsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListingsShow propertiesHide properties
smartgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListing[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListingidstringslugstringstaticgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListing[] | nullparent_product_idstringpurchase_pricegithub_com_enadhq_nabbit_internal_pkg_webserver_models.PurchasePrice | nullShow propertiesHide properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.PurchasePrice
currencystringvalue_centsintegernull
nullshipping_attributesstring[] | nullstatusstringstore_groupgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantStoreGroupWithPrices[] | nullProduct StoreGroup
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantStoreGroupWithPricescreated_atstringidstringnamestringpricesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantPrice[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantPriceamount_cents_with_taxintegercreated_atstringidstringmarketgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Marketon_salebooleanreference_price_with_taxinteger | nullsale_end_timestampstring | nullsale_price_with_taxinteger | nullsale_start_timestampstring | nullstatusgithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceStatusAllowed:
activeinactivedraftupdated_atstring | nullslugstringstore_typestringupdated_atstring | nulltagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Tag[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Tagattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullcreated_atstringfilterablebooleanidstringkeystringmarketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | nullnamestringschedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | nullstatusstringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.TagTranslationsupdated_atstring | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantTranslationsShow propertiesHide properties
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullupdated_atstring | nullvalidate_stockbooleanvariant_dimensionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Dimensions | nullShow propertiesHide properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.Dimensions
github_com_enadhq_nabbit_internal_pkg_webserver_models.Dimensionsnull
nullvariant_group_idstringvariant_namestringvariant_numberstringvideosgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Video[] | nullVideos of the product
warehouse_variant_stockgithub_com_enadhq_nabbit_internal_pkg_webserver_models.WarehouseVariantStock[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.WarehouseVariantStockavailable_onlinebooleancreated_atstringidstringinventory_datestring | nullquantityintegerupdated_atstring | nullwarehouse_namestringwarehouse_slugstringvideosgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Video[] | nullVideos of the product
Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Videoattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nulldescriptionstringfolder_idstringidstringpathstringpublicbooleanstatusstringtitlestringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoTranslationsShow propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nulltitlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullvariantsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariant[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariantformatstringheightintegerurlstringwidthintegerdetailsstring[]Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanrequired400
Invalid request
detailsstring[]messagestringsuccessbooleanrequired401
Unauthorized access
detailsstring[]messagestringsuccessbooleanrequired500
Internal server error
detailsstring[]messagestringsuccessbooleanrequired