> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Set a product's status and labels on the panel

> What resellers read beside a product on the panel, never the product's own badges: one status and labels, as a product's badges are written. An empty list takes them off. 404 for a product the panel does not sell. Answers every product's, by its ID.

Needs the `resellers.write` permission (Change Resellers).



## OpenAPI

````yaml /api-reference/openapi.json put /stores/{storeId}/resellers/products/{productId}/badges
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Teams
  - name: Resellers
  - name: Blacklist
  - name: Allowlist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/resellers/products/{productId}/badges:
    put:
      tags:
        - Resellers
      summary: Set a product's status and labels on the panel
      description: >-
        What resellers read beside a product on the panel, never the product's
        own badges: one status and labels, as a product's badges are written. An
        empty list takes them off. 404 for a product the panel does not sell.
        Answers every product's, by its ID.


        Needs the `resellers.write` permission (Change Resellers).
      operationId: resellerProducts.badges
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: productId
          in: path
          required: true
          description: The product.
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                badges:
                  type: array
                  description: >-
                    Up to 3, each `{ label, color, kind }`: `label` 1 to 32
                    characters; `color` one of `blue`, `green`, `amber`, `red`,
                    `purple` and `gray`, a `#rrggbb` colour, or empty for the
                    plain look; `kind` `label`, or `status` for one at most.
                  items:
                    type: object
                  example:
                    - label: Available
                      color: green
                      kind: status
              required:
                - badges
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      7626c760-c6cd-4b38-8344-cfbba0148a80:
                        type: array
                        items:
                          type: object
                          properties:
                            label:
                              type: string
                            color:
                              type: string
                            kind:
                              type: string
                  meta:
                    type: object
                    properties:
                      panel:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                          currency:
                            type: string
                          minTopup:
                            type: integer
                      products:
                        type: array
                        items:
                          type: object
                          properties:
                            variantId:
                              type: string
                            productId:
                              type: string
                            productName:
                              type: string
                            variantName:
                              type: string
                            image:
                              nullable: true
                            delivery:
                              type: string
                            stock:
                              type: integer
                            price:
                              type: number
                            minQty:
                              type: integer
                            dailyCap:
                              type: integer
                            maxDiscount:
                              nullable: true
                            enabled:
                              type: boolean
                      tiers:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            discount:
                              type: number
                            resellers:
                              type: integer
                            spent30:
                              type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  7626c760-c6cd-4b38-8344-cfbba0148a80:
                    - label: Available
                      color: green
                      kind: status
                meta:
                  panel:
                    enabled: true
                    currency: USD
                    minTopup: 25
                  products:
                    - variantId: 17e8cb5f-acf9-4f64-bf6b-274b0c6b3183
                      productId: 7626c760-c6cd-4b38-8344-cfbba0148a80
                      productName: Northwind Pro
                      variantName: 1 month
                      image: null
                      delivery: license_keys
                      stock: 4
                      price: 6.5
                      minQty: 1
                      dailyCap: 100
                      maxDiscount: null
                      enabled: true
                  tiers:
                    - id: 53272267-b8de-4f7f-9c0e-00f69122b91e
                      name: Gold
                      discount: 12.5
                      resellers: 0
                      spent30: 0
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Refused'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.resellerProducts.badges("PRODUCT_ID", {
              badges: [{"label":"Available","color":"green","kind":"status"}],
            });
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->resellerProducts->badges('PRODUCT_ID', [
                'badges' => [['label' => 'Available', 'color' => 'green', 'kind' => 'status']],
            ]);
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.resellerProducts.badges(
                "PRODUCT_ID",
                badges=[{"label": "Available", "color": "green", "kind": "status"}],
            )
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A word of your own for this one change, up to 180 letters, digits, dots,
        dashes, underscores and colons. Sent again with the same key, the
        request is not carried out twice: the first answer comes back, with
        `Idempotent-Replay: true`.
      schema:
        type: string
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    Refused:
      description: >-
        The request was understood and not carried out. `validation_failed` says
        what is wrong with each field under `errors`; other codes are the
        route's own.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.