Create

View as Markdown
Creates a resource. This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

Request

This endpoint expects an object.
namestringRequired
Resource name
external_resource_idstringRequired
Merchant resource ID
descriptionstringOptional
Resource description
image_urlstringOptional
Resource image URL

Response

201
public_idstringOptional
merchantstringOptional
namestringOptional
external_resource_idstringOptional
descriptionstring or nullOptional
image_urlstringOptional
createdstringOptional
last_updatedstringOptional

Errors

400
Bad Request Error
403
Forbidden Error