Products

📦 Manage your product inventory, pricing, and details.

List All Products

get

Retrieve a paginated list of all products in your store.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Query parameters

searchstringOptional

Filter by name or slug

statusstringOptional

Filter by status (active, draft, hidden)

limitintegerOptionalDefault: 50

offsetintegerOptionalDefault: 0

Responses

200

List of products

application/json

get

/products

HTTPcURLJavaScriptPython

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

200

List of products

{
  "success": true,
  "products": [
    {
      "id": 101,
      "hash_id": "a1b2c3d4e5f6",
      "name": "Premium License Key",
      "slug": "premium-license-key",
      "type": "serials",
      "price_cents": 2999,
      "currency": "USD",
      "status": "active",
      "active": 1,
      "sales_count": 5,
      "categories": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "details": {
        "short_description": "text",
        "description_html": "text"
      }
    }
  ]
}

Create New Product

post

Create a new product in your inventory.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Body

application/json

namestringRequired

slugstringRequired

typestring · enumOptionalDefault: filePossible values:

price_centsintegerOptionalDefault: 0

Responses

200

Product created successfully

application/json

post

/products

HTTPcURLJavaScriptPython

POST /api_user/api/v1/products 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: 59

{
  "name": "text",
  "slug": "text",
  "type": "file",
  "price_cents": 0
}

200

Product created successfully

{
  "success": true,
  "product": {
    "id": 101,
    "hash_id": "a1b2c3d4e5f6",
    "name": "Premium License Key",
    "slug": "premium-license-key",
    "type": "serials",
    "price_cents": 2999,
    "currency": "USD",
    "status": "active",
    "active": 1,
    "sales_count": 5,
    "categories": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "details": {
      "short_description": "text",
      "description_html": "text"
    }
  }
}

Get Product Details

get

Retrieve full details for a single product by numeric ID or Hash ID.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

idstringRequired

The product ID (e.g. 101) or Hash ID (e.g. abc123xyz)

Responses

200

Product details

application/json

get

/products/{id}

HTTPcURLJavaScriptPython

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

200

Product details

{
  "success": true,
  "product": {
    "id": 101,
    "hash_id": "a1b2c3d4e5f6",
    "name": "Premium License Key",
    "slug": "premium-license-key",
    "type": "serials",
    "price_cents": 2999,
    "currency": "USD",
    "status": "active",
    "active": 1,
    "sales_count": 5,
    "categories": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "details": {
      "short_description": "text",
      "description_html": "text"
    }
  }
}

Update Product Details

put

Update details of an existing product.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

idstringRequired

Body

application/json

idintegerOptionalExample: 101

hash_idstringOptionalExample: a1b2c3d4e5f6

namestringOptionalExample: Premium License Key

slugstringOptionalExample: premium-license-key

typestring · enumOptionalExample: serialsPossible values:

price_centsintegerOptional

Price in cents (e.g., 1000 = $10.00)

Example: 2999

currencystringOptionalExample: USD

statusstring · enumOptionalExample: activePossible values:

activeinteger · enumOptionalExample: 1Possible values:

sales_countintegerOptionalExample: 5

Responses

200

Product updated

application/json

put

/products/{id}

HTTPcURLJavaScriptPython

PUT /api_user/api/v1/products/{id} 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: 294

{
  "id": 101,
  "hash_id": "a1b2c3d4e5f6",
  "name": "Premium License Key",
  "slug": "premium-license-key",
  "type": "serials",
  "price_cents": 2999,
  "currency": "USD",
  "status": "active",
  "active": 1,
  "sales_count": 5,
  "categories": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "details": {
    "short_description": "text",
    "description_html": "text"
  }
}

200

Product updated

{
  "success": true,
  "product": {
    "id": 101,
    "hash_id": "a1b2c3d4e5f6",
    "name": "Premium License Key",
    "slug": "premium-license-key",
    "type": "serials",
    "price_cents": 2999,
    "currency": "USD",
    "status": "active",
    "active": 1,
    "sales_count": 5,
    "categories": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "details": {
      "short_description": "text",
      "description_html": "text"
    }
  }
}

Delete Product

delete

Permanently remove a product from your store.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

idstringRequired

Responses

200

Product deleted

application/json

delete

/products/{id}

HTTPcURLJavaScriptPython

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

200

Product deleted

{
  "success": true
}