List published public storefront products

GET/v2/public/storefronts/{locator}/products

Path parameters

locatorstringrequired

min length 1 · max length 160

Query parameters

langstring

Allowed:enar

expectedMerchantIdstring<uuid>

expectedHostRevisioninteger

min -9007199254740991 · max 9007199254740991

cursorstring

min length 1 · max length 256

querystring

min length 1 · max length 160

limitinteger

min 1 · max 100 · default: 25

Header parameters

x-request-idstring

Optional caller-provided request correlation ID.

min length 1

Responses

200OK

bindingobject | anyrequired

Show properties

Any of:

object

merchantIdstring<uuid>required

environmentstringrequired

Allowed:sandboxproduction

hostnamestringrequired

min length 1 · max length 253

publicSlugstringrequired

min length 1 · max length 63

hostRevisionintegerrequired

min -9007199254740991 · max 9007199254740991

publicContentRevisionintegerrequired

min -9007199254740991 · max 9007199254740991

defaultLocalestringrequired

Allowed:enar

any

any

productsobject[]required

Show properties

Array of object

idstring<uuid>required

namestringrequired

min length 1 · max length 160

descriptionstring | anyrequired

Show properties

Any of:

string

string

any

any

taxBehaviorstringrequired

Allowed:standardexempt

offersobject[]required

Show properties

Array of object

idstring<uuid>required

namestringrequired

min length 1 · max length 160

descriptionstring | anyrequired

Show properties

Any of:

string

string

any

any

offerTypestringrequired

Allowed:one_timerecurringfreecustom

positionintegerrequired

min 0 · max 9007199254740991

isDefaultbooleanrequired

currencyanyrequired

amountHalalasinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

minimumAmountHalalasinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

maximumAmountHalalasinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

cadenceobject | anyrequired

Show properties

Any of:

object

intervalUnitstringrequired

Allowed:dayweekmonthyear

intervalCountintegerrequired

min -9007199254740991 · max 9007199254740991

any

any

trialDaysintegerrequired

min 0 · max 365

assetsobject[]required

Show properties

Array of object

idstring<uuid>required

purposeanyrequired

mimeTypestringrequired

min length 1 · max length 160

altTextstring | anyrequired

Show properties

Any of:

string

string

any

any

urlstring<uri>required

expiresAtstring<date-time>required

positionintegerrequired

min 0 · max 9007199254740991

linksobject[]required

Show properties

Array of object

idstring<uuid>required

titlestringrequired

min length 1 · max length 120

urlstring<uri>required

positionintegerrequired

min 0 · max 9007199254740991

nextCursorstring | anyrequired

Show properties

Any of:

string

string

any

any

404Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

422Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

429Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

500Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

Request

curl -X GET "https://api.cipay.net/v2/public/storefronts/string/products"

const response = await fetch("https://api.cipay.net/v2/public/storefronts/string/products", {
  method: "GET"
});

Response

{
  "binding": {
    "merchantId": "<uuid>",
    "environment": "sandbox",
    "hostname": "string",
    "publicSlug": "string",
    "hostRevision": 0,
    "publicContentRevision": 0,
    "defaultLocale": "en"
  },
  "products": [
    {
      "id": "<uuid>",
      "name": "string",
      "description": "string",
      "taxBehavior": "standard",
      "offers": [
        {
          "id": "<uuid>",
          "name": "string",
          "description": "string",
          "offerType": "one_time",
          "position": 0,
          "isDefault": true,
          "currency": "SAR",
          "amountHalalas": 0,
          "minimumAmountHalalas": 0,
          "maximumAmountHalalas": 0,
          "cadence": {
            "intervalUnit": "day",
            "intervalCount": 0
          },
          "trialDays": 0
        }
      ],
      "assets": [
        {
          "id": "<uuid>",
          "purpose": "product_media",
          "mimeType": "string",
          "altText": "string",
          "url": "<uri>",
          "expiresAt": "2024-01-01T00:00:00Z",
          "position": 0
        }
      ],
      "links": [
        {
          "id": "<uuid>",
          "title": "string",
          "url": "<uri>",
          "position": 0
        }
      ]
    }
  ],
  "nextCursor": "string"
}