Get a Product

GET/v2/products/{id}

Authorization

AuthorizationBearer token · headerrequired

Merchant API key scoped to one merchant and environment. Read operations require api:read, normal write operations require api:write, and broadcast mutations also require explicit broadcasts:write.

Path parameters

idstring<uuid>required

Header parameters

x-request-idstring

Optional caller-provided request correlation ID.

min length 1

Responses

200OK

productobjectrequired

Show properties

idstring<uuid>required

merchantIdstring<uuid>required

environmentstringrequired

Allowed:sandboxproduction

namestringrequired

min length 1 · max length 160

descriptionstring | anyrequired

Show properties

Any of:

string

string

any

any

lifecyclestring | anyrequired

Show properties

Any of:

string

string

any

any

taxBehaviorstring | anyrequired

Show properties

Any of:

string

string

any

any

revisionintegerrequired

min -9007199254740991 · max 9007199254740991

publishedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

archivedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

archivedByUserIdstring<uuid> | anyrequired

Show properties

Any of:

string<uuid>

string<uuid>

any

any

createdByUserIdstring<uuid>required

offersobject[]required

Show properties

Array of object

idstring<uuid>required

merchantIdstring<uuid>required

environmentstringrequired

Allowed:sandboxproduction

productIdstring<uuid>required

offerTypestringrequired

Allowed:one_timerecurringfreecustom

namestringrequired

min length 1 · max length 160

descriptionstring | anyrequired

Show properties

Any of:

string

string

any

any

positionintegerrequired

min 0 · max 9007199254740991

statusstringrequired

Allowed:draftpublishedretired

isDefaultbooleanrequired

revisionintegerrequired

min -9007199254740991 · max 9007199254740991

publishedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

retiredAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

createdByUserIdstring<uuid>required

versionsobject[]required

Show properties

Array of object

idstring<uuid>required

merchantIdstring<uuid>required

environmentstringrequired

Allowed:sandboxproduction

productIdstring<uuid>required

offerIdstring<uuid>required

offerTypestringrequired

Allowed:one_timerecurringfreecustom

versionNumberintegerrequired

min -9007199254740991 · max 9007199254740991

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

intervalUnitstring | anyrequired

Show properties

Any of:

string

string

any

any

intervalCountinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

trialDaysintegerrequired

min 0 · max 365

statusstringrequired

Allowed:draftpublishedreplaced

publishedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

replacedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

createdByUserIdstring<uuid>required

createdAtstring<date-time>required

updatedAtstring<date-time>required

createdAtstring<date-time>required

updatedAtstring<date-time>required

assetsobject[]required

Show properties

Array of object

idstring<uuid>required

productIdstring<uuid>required

assetIdstring<uuid>required

purposestringrequired

Allowed:product_mediaproduct_file

positionintegerrequired

min 0 · max 9007199254740991

assetobjectrequired

Show properties

idstring<uuid>required

merchantIdstring<uuid>required

environmentstringrequired

Allowed:sandboxproduction

productIdstring<uuid> | anyrequired

Show properties

Any of:

string<uuid>

string<uuid>

any

any

purposestringrequired

Allowed:merchant_logocustomer_avatarproduct_mediaproduct_file

mimeTypestringrequired

matches ^[a-z0-9][a-z0-9!#$&^_.+-]{0,126}\/[a-z0-9][a-z0-9!#$&^_.+-]{0,126}$

byteSizeintegerrequired

min 1 · max 9007199254740991

checksumSha256stringrequired

matches ^[a-f0-9]{64}$

statusstringrequired

Allowed:pendingquarantinedreadyrejecteddeleted

revisionintegerrequired

min -9007199254740991 · max 9007199254740991

createdAtstring<date-time>required

updatedAtstring<date-time>required

createdAtstring<date-time>required

updatedAtstring<date-time>required

linksobject[]required

Show properties

Array of object

idstring<uuid>required

productIdstring<uuid>required

titlestringrequired

min length 1 · max length 120

urlstring<uri>required

positionintegerrequired

min 0 · max 9007199254740991

createdAtstring<date-time>required

updatedAtstring<date-time>required

createdAtstring<date-time>required

updatedAtstring<date-time>required

401Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

403Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

404Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

409Standard 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/products/%3Cuuid%3E" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.cipay.net/v2/products/%3Cuuid%3E", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "product": {
    "id": "<uuid>",
    "merchantId": "<uuid>",
    "environment": "sandbox",
    "name": "string",
    "description": "string",
    "lifecycle": "draft",
    "taxBehavior": "standard",
    "revision": 0,
    "publishedAt": "2024-01-01T00:00:00Z",
    "archivedAt": "2024-01-01T00:00:00Z",
    "archivedByUserId": "<uuid>",
    "createdByUserId": "<uuid>",
    "offers": [
      {
        "id": "<uuid>",
        "merchantId": "<uuid>",
        "environment": "sandbox",
        "productId": "<uuid>",
        "offerType": "one_time",
        "name": "string",
        "description": "string",
        "position": 0,
        "status": "draft",
        "isDefault": true,
        "revision": 0,
        "publishedAt": "2024-01-01T00:00:00Z",
        "retiredAt": "2024-01-01T00:00:00Z",
        "createdByUserId": "<uuid>",
        "versions": [
          {
            "id": "<uuid>",
            "merchantId": "<uuid>",
            "environment": "sandbox",
            "productId": "<uuid>",
            "offerId": "<uuid>",
            "offerType": "one_time",
            "versionNumber": 0,
            "currency": "SAR",
            "amountHalalas": 0,
            "minimumAmountHalalas": 0,
            "maximumAmountHalalas": 0,
            "intervalUnit": "day",
            "intervalCount": 0,
            "trialDays": 0,
            "status": "draft",
            "publishedAt": "2024-01-01T00:00:00Z",
            "replacedAt": "2024-01-01T00:00:00Z",
            "createdByUserId": "<uuid>",
            "createdAt": "2024-01-01T00:00:00Z",
            "updatedAt": "2024-01-01T00:00:00Z"
          }
        ],
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      }
    ],
    "assets": [
      {
        "id": "<uuid>",
        "productId": "<uuid>",
        "assetId": "<uuid>",
        "purpose": "product_media",
        "position": 0,
        "asset": {
          "id": "<uuid>",
          "merchantId": "<uuid>",
          "environment": "sandbox",
          "productId": "<uuid>",
          "purpose": "merchant_logo",
          "mimeType": "string",
          "byteSize": 0,
          "checksumSha256": "string",
          "status": "pending",
          "revision": 0,
          "createdAt": "2024-01-01T00:00:00Z",
          "updatedAt": "2024-01-01T00:00:00Z"
        },
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      }
    ],
    "links": [
      {
        "id": "<uuid>",
        "productId": "<uuid>",
        "title": "string",
        "url": "<uri>",
        "position": 0,
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      }
    ],
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}