Coupons

🎟️ Manage discount codes and promotions.

List All Coupons

get

List all available coupons.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Responses

200

List of coupons

application/json

get

/coupons

HTTPcURLJavaScriptPython

GET /api_user/api/v1/coupons HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

List of coupons

{
  "success": true,
  "coupons": [
    {
      "id": 12,
      "hash_id": "X8Y9Z0A1",
      "code": "SUMMER2024",
      "type": "percent",
      "value": 20,
      "max_uses": 100,
      "used_count": 5,
      "valid_from": "2026-01-27T17:55:10.084Z",
      "valid_to": "2026-01-27T17:55:10.084Z",
      "status": "active",
      "created_at": "2026-01-27T17:55:10.084Z",
      "products": [
        {
          "id": 1,
          "name": "text",
          "slug": "text"
        }
      ]
    }
  ]
}

Create New Coupon

post

Create a new coupon.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Body

application/json

codestringRequired

valuenumberRequired

Responses

200

Coupon created

application/json

post

/coupons

HTTPcURLJavaScriptPython

POST /api_user/api/v1/coupons HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "code": "text",
  "value": 1
}

200

Coupon created

{
  "success": true
}

Get Coupon Details

get

Get details of a specific coupon.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

idintegerRequired

Responses

200

Coupon details

application/json

get

/coupons/{id}

HTTPcURLJavaScriptPython

GET /api_user/api/v1/coupons/{id} HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

Coupon details

{
  "success": true,
  "coupon": {
    "id": 12,
    "hash_id": "X8Y9Z0A1",
    "code": "SUMMER2024",
    "type": "percent",
    "value": 20,
    "max_uses": 100,
    "used_count": 5,
    "valid_from": "2026-01-27T17:55:10.084Z",
    "valid_to": "2026-01-27T17:55:10.084Z",
    "status": "active",
    "created_at": "2026-01-27T17:55:10.084Z",
    "products": [
      {
        "id": 1,
        "name": "text",
        "slug": "text"
      }
    ]
  }
}

Delete Coupon

delete

Delete a coupon.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

idintegerRequired

Responses

200

Deleted

application/json

delete

/coupons/{id}

HTTPcURLJavaScriptPython

DELETE /api_user/api/v1/coupons/{id} HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

Deleted

{
  "success": true
}