Unpublish a live or scheduled marketplace listing - DigetPay Developer Integration API

Transitions the listing from PUBLISHED or SCHEDULED to UNPUBLISHED,
removing it from the customer-facing marketplace.

When called on a SCHEDULED listing the pending publishAt is cleared so
the listing will not auto-publish later.

The listing must be PUBLISHED or SCHEDULED — any other status returns
400.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

The listing after unpublishing.

Bodyapplication/json

Example

{
    "id": "9",
    "applicationId": "7",
    "status": "DRAFT",
    "nameEn": "Acme Checkout",
    "nameAr": "تشيك أوت أكمة",
    "descriptionEn": "DigetPay checkout for Acme services.",
    "descriptionAr": "الدفع عبر ديجت باي لخدمات أكمة.",
    "iconPath": "https://storage/dgp/logo.png",
    "bannerPath": "https://storage/dgp/banner.png",
    "screenshots": [
        "https://storage/dgp/screen-1.png"
    ],
    "targetCountries": [
        "SA"
    ],
    "isFeatured": false,
    "publishAt": "2026-08-20T08:00:00.000Z",
    "publishedAt": "2026-08-15T12:00:00.000Z",
    "reviewNotes": {
        "branding": "2026-08-10: Logo updated per reviewer request"
    },
    "reviewNotesJson": {
        "branding": "2026-08-10: Logo updated per reviewer request"
    },
    "category": {
        "id": "3",
        "slug": "food",
        "nameEn": "Food & Dining",
        "nameAr": "طعام ومطاعم"
    },
    "offers": [
        {
            "id": "42",
            "panelId": "12",
            "sortOrder": 0,
            "titleEn": "Silver top-up",
            "titleAr": "تعبئة فضية",
            "descriptionEn": "string",
            "descriptionAr": "string",
            "imageUrl": "https://storage.googleapis.com/...?Signature=...",
            "design": "banner",
            "linkType": "deeplink",
            "url": "https://partner.acme.sa/buy/silver",
            "price": "49.99",
            "originalPrice": "79.99",
            "currency": "SAR",
            "inStock": true,
            "available": true,
            "perUserLimit": 5,
            "badgeLabel": "Best seller",
            "badgeColor": "#E8553C",
            "bannerImageUrl": "https://storage.googleapis.com/...?Signature=...",
            "highlightText": "Limited-time offer",
            "termsEn": "Digital card delivered instantly. Non-refundable.",
            "termsAr": "البطاقة الرقمية تُسلَّم فوراً وغير قابلة للاسترداد.",
            "offerExpiresAt": "2026-12-31T23:59:59.000Z",
            "fulfillmentMode": "INSTANT"
        }
    ],
    "panels": [
        {
            "id": "12",
            "sortOrder": 0,
            "layout": "HERO_CAROUSEL",
            "panelType": "OCCASIONS",
            "titleEn": "Gift cards",
            "titleAr": "بطاقات الهدايا",
            "showTitle": false,
            "featuredStoreId": "101",
            "featuredStoreLabelEn": "Acme Store",
            "featuredStoreLabelAr": "متجر أكمة",
            "subtitleEn": "Iftar & suhoor deals, all month",
            "subtitleAr": "عروض الإفطار والسحور طوال الشهر",
            "themeColor": "#16A34A",
            "bodyEn": "Buy a gift card and it lands instantly in your account.",
            "bodyAr": "اشترِ بطاقة هدايا وستصلك فوراً إلى حسابك.",
            "expiresAt": "2026-09-18T21:00:00.000Z",
            "bannerImageUrl": "https://storage/dgp/panel-banner.png",
            "offers": [
                {
                    "id": "42",
                    "panelId": "12",
                    "sortOrder": 0,
                    "titleEn": "Silver top-up",
                    "titleAr": "تعبئة فضية",
                    "descriptionEn": "string",
                    "descriptionAr": "string",
                    "imageUrl": "https://storage.googleapis.com/...?Signature=...",
                    "design": "banner",
                    "linkType": "deeplink",
                    "url": "https://partner.acme.sa/buy/silver",
                    "price": "49.99",
                    "originalPrice": "79.99",
                    "currency": "SAR",
                    "inStock": true,
                    "available": true,
                    "perUserLimit": 5,
                    "badgeLabel": "Best seller",
                    "badgeColor": "#E8553C",
                    "bannerImageUrl": "https://storage.googleapis.com/...?Signature=...",
                    "highlightText": "Limited-time offer",
                    "termsEn": "Digital card delivered instantly. Non-refundable.",
                    "termsAr": "البطاقة الرقمية تُسلَّم فوراً وغير قابلة للاسترداد.",
                    "offerExpiresAt": "2026-12-31T23:59:59.000Z",
                    "fulfillmentMode": "INSTANT"
                }
            ]
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found