Groups

📑 Create and manage product groups/collections.

List All Groups

get

List all product groups.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Responses

200

List of groups

application/json

get

/groups

HTTPcURLJavaScriptPython

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

200

List of groups

{
  "success": true,
  "groups": [
    {
      "id": 25,
      "name": "Featured Products",
      "slug": "featured-products",
      "image_url": "https://example.com/image.png",
      "unlisted": 0,
      "product_count": 3,
      "products": [
        {
          "id": 1,
          "name": "text",
          "slug": "text"
        }
      ]
    }
  ]
}

Create New Group

post

Create a new product group.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Body

application/json

namestringRequired

Responses

200

Group created

application/json

post

/groups

HTTPcURLJavaScriptPython

POST /api_user/api/v1/groups 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: 15

{
  "name": "text"
}

200

Group created

{
  "success": true,
  "group": {
    "id": 25,
    "name": "Featured Products",
    "slug": "featured-products",
    "image_url": "https://example.com/image.png",
    "unlisted": 0,
    "product_count": 3,
    "products": [
      {
        "id": 1,
        "name": "text",
        "slug": "text"
      }
    ]
  }
}

Get Group Details

get

Get details of a specific group and its products.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

idintegerRequired

Responses

200

Group details

application/json

get

/groups/{id}

HTTPcURLJavaScriptPython

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

200

Group details

{
  "success": true,
  "group": {
    "id": 25,
    "name": "Featured Products",
    "slug": "featured-products",
    "image_url": "https://example.com/image.png",
    "unlisted": 0,
    "product_count": 3,
    "products": [
      {
        "id": 1,
        "name": "text",
        "slug": "text"
      }
    ]
  }
}

Delete Group

delete

Delete a product group.

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

/groups/{id}

HTTPcURLJavaScriptPython

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

200

Deleted

{
  "success": true
}