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

# Get business collection

> **Protocols:** Linked Device API

**Required scope:** `business:read`



## OpenAPI

````yaml api-reference/features/waba-features.json GET /messaging/{session}/business/collections/{collectionId}
openapi: 3.0.3
info:
  title: WABA features API methods
  version: 1.0.0
  description: >-
    Task-focused waba features methods across supported Polymorfa connection
    types.
servers: []
security: []
paths:
  /messaging/{session}/business/collections/{collectionId}:
    get:
      tags:
        - Catalog and commerce
      summary: Get business collection
      description: |-
        **Protocols:** Linked Device API

        **Required scope:** `business:read`
      operationId: nativeGetBusinessCollection
      parameters:
        - schema:
            type: string
          required: true
          name: session
          in: path
          description: Identifier of the connected Polymorfa session.
        - schema:
            type: string
            maxLength: 256
          required: true
          name: collectionId
          in: path
          description: |-
            Identifier for the collection.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | String length | At most `256` characters |
        - schema:
            type: string
            maxLength: 256
            pattern: ^pmfa_lid_[1-9]\d*$
          required: true
          name: id
          in: query
          description: |-
            Identifier for this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | String length | At most `256` characters |
            | Pattern | `^pmfa_lid_[1-9]\d*$` |
        - schema:
            type: string
            maxLength: 2048
          required: false
          name: after
          in: query
          description: |-
            Specifies after for this query parameter.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | String length | At most `2048` characters |
        - schema:
            type: integer
            minimum: 1
            maximum: 100
          required: false
          name: limit
          in: query
          description: |-
            Specifies limit for this query parameter.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `1` through `100` (inclusive) |
        - schema:
            type: integer
            minimum: 1
            maximum: 1024
          required: false
          name: width
          in: query
          description: |-
            Width in pixels.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `1` through `1024` (inclusive) |
        - schema:
            type: integer
            minimum: 1
            maximum: 1024
          required: false
          name: height
          in: query
          description: |-
            Height in pixels.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `1` through `1024` (inclusive) |
      responses:
        '200':
          description: Live collection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/native__GetBusinessCollectionResponse'
        '400':
          description: Bad request — request body or params failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/native__PublicError'
              example:
                error:
                  type: invalid_request_error
                  code: invalid_parameter
                  message: Correct the invalid request field.
                  param: null
                data: null
                docs: https://docs.polymorfa.com/api/errors#invalid-parameter
        '401':
          description: Missing or invalid authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/native__PublicError'
              example:
                error:
                  type: authentication_error
                  code: invalid_credential
                  message: Supply a valid credential.
                  param: null
                data: null
                docs: https://docs.polymorfa.com/api/errors#invalid-credential
        '403':
          description: Authenticated but not permitted (missing scope or rule violation)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/native__PublicError'
              example:
                error:
                  type: permission_error
                  code: permission_denied
                  message: The credential does not have access to this resource.
                  param: null
                data: null
                docs: https://docs.polymorfa.com/api/errors#permission-denied
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/native__PublicError'
              example:
                error:
                  type: invalid_request_error
                  code: resource_not_found
                  message: The resource is unavailable to this caller.
                  param: null
                data: null
                docs: https://docs.polymorfa.com/api/errors#resource-not-found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/native__PublicError'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: >-
                    An unexpected service failure occurred. Keep the request ID
                    for support.
                  param: null
                data: null
                docs: https://docs.polymorfa.com/api/errors#internal-error
        '502':
          description: Upstream WhatsApp request failed or its response could not be mapped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/native__PublicError'
              example:
                error:
                  type: upstream_error
                  code: upstream_failure
                  message: The messaging provider could not complete the request.
                  param: null
                data: null
                docs: https://docs.polymorfa.com/api/errors#upstream-failure
      security:
        - native__BearerAuth: []
      servers:
        - url: https://api.polymorfa.com
components:
  schemas:
    native__GetBusinessCollectionResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
          description: |-
            Whether the request succeeded.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `true` | True. |
        data:
          allOf:
            - $ref: '#/components/schemas/native__BusinessCollection'
          description: Structured data carried by this object.
      required:
        - success
        - data
    native__PublicError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              enum:
                - invalid_parameter
                - invalid_credential
                - entitlement_required
                - method_not_allowed
                - permission_denied
                - missing_scope
                - resource_not_found
                - media_fetch_failed
                - resource_gone
                - state_conflict
                - rate_limit_exceeded
                - internal_error
                - operation_not_supported
                - upstream_failure
                - service_unavailable
                - credential_verification_unavailable
                - session_not_ready
                - command_dispatch_failed
                - result_unknown
              description: >-
                Stable machine-readable code for this result.


                <!-- polymorfa-input-table -->

                **Allowed values**

                | Value | Meaning |

                | --- | --- |

                | `invalid_parameter` | Invalid parameter. |

                | `invalid_credential` | Invalid credential. |

                | `entitlement_required` | Entitlement required. |

                | `method_not_allowed` | Method not allowed. |

                | `permission_denied` | Permission denied. |

                | `missing_scope` | Missing scope. |

                | `resource_not_found` | Resource not found. |

                | `media_fetch_failed` | Media fetch failed. |

                | `resource_gone` | Resource gone. |

                | `state_conflict` | State conflict. |

                | `rate_limit_exceeded` | Rate limit exceeded. |

                | `internal_error` | Internal error. |

                | `operation_not_supported` | Operation not supported. |

                | `upstream_failure` | Upstream failure. |

                | `service_unavailable` | Service unavailable. |

                | `credential_verification_unavailable` | Credential
                verification unavailable. |

                | `session_not_ready` | Session not ready. |

                | `command_dispatch_failed` | Command dispatch failed. |

                | `result_unknown` | Result unknown. |
            message:
              type: string
              description: Human-readable message associated with this result.
            param:
              type: string
              nullable: true
              description: |-
                Specifies param for this error.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
          required:
            - type
            - code
            - message
            - param
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Specifies docs for this native public error.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
      required:
        - error
        - data
        - docs
    native__BusinessCollection:
      type: object
      properties:
        id:
          type: string
          description: Identifier for this resource.
        name:
          type: string
          description: Human-readable name for this resource.
        products:
          type: array
          items:
            $ref: '#/components/schemas/native__BusinessProduct'
          description: Products returned by this operation.
        status:
          type: object
          properties:
            status:
              type: string
              description: Current status of this resource or operation.
            canAppeal:
              type: boolean
              description: Whether appeal.
            commerceUrl:
              type: string
              format: uri
              description: |-
                URL for the commerce.

                <!-- polymorfa-input-table -->
                **Value constraints**
                | Constraint | Accepted input |
                | --- | --- |
                | Format | `uri` |
            rejectReason:
              type: string
              description: Reason the submitted resource was rejected.
          required:
            - canAppeal
          description: Structured status details for this native business collection.
      required:
        - id
        - name
        - products
        - status
    native__BusinessProduct:
      type: object
      properties:
        id:
          type: string
          description: Identifier for this resource.
        retailerId:
          type: string
          description: Merchant-defined identifier for the catalog item.
        belongsTo:
          type: string
          description: Specifies belongs to for this native business product.
        name:
          type: string
          description: Human-readable name for this resource.
        description:
          type: string
          description: Human-readable description of this resource.
        price:
          type: string
          description: >-
            Price as a digit string in thousandths of the declared currency
            unit.
        currency:
          type: string
          description: ISO 4217 currency code.
        url:
          type: string
          format: uri
          description: |-
            URL associated with this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
        shimmedUrl:
          type: string
          format: uri
          description: |-
            URL for the shimmed.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
        hidden:
          type: boolean
          description: Whether this resource is hidden from ordinary listings.
        sanctioned:
          type: boolean
          description: Whether sanctioned.
        maxAvailable:
          type: integer
          minimum: 0
          description: |-
            Specifies max available for this native business product.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        availability:
          type: string
          description: Specifies availability for this native business product.
        complianceCategory:
          type: string
          description: Specifies compliance category for this native business product.
        compliance:
          type: object
          properties:
            countryCodeOrigin:
              type: string
              description: ISO 3166-1 alpha-2 country code where the product originated.
            importerName:
              type: string
              description: Name of the product importer declared for compliance.
            importerAddress:
              type: object
              properties:
                street1:
                  type: string
                  description: Specifies street1 for this importer address.
                street2:
                  type: string
                  description: Specifies street2 for this importer address.
                city:
                  type: string
                  description: Specifies city for this importer address.
                region:
                  type: string
                  description: Specifies region for this importer address.
                postalCode:
                  type: string
                  description: Machine-readable postal code for this importer address.
                countryCode:
                  type: string
                  description: ISO 3166-1 alpha-2 country code.
              description: Structured importer address values for this compliance.
          description: Structured compliance values for this native business product.
        media:
          type: object
          properties:
            images:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    description: Identifier for this resource.
                  originalUrl:
                    type: string
                    format: uri
                    description: |-
                      Original URL supplied before normalization or proxying.

                      <!-- polymorfa-input-table -->
                      **Value constraints**
                      | Constraint | Accepted input |
                      | --- | --- |
                      | Format | `uri` |
                  requestUrl:
                    type: string
                    format: uri
                    description: |-
                      URL for the request.

                      <!-- polymorfa-input-table -->
                      **Value constraints**
                      | Constraint | Accepted input |
                      | --- | --- |
                      | Format | `uri` |
                required:
                  - id
              description: Images attached to or representing this resource.
            videos:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    description: Identifier for this resource.
                  originalUrl:
                    type: string
                    format: uri
                    description: |-
                      Original URL supplied before normalization or proxying.

                      <!-- polymorfa-input-table -->
                      **Value constraints**
                      | Constraint | Accepted input |
                      | --- | --- |
                      | Format | `uri` |
                  thumbnailUrl:
                    type: string
                    format: uri
                    description: |-
                      URL for the thumbnail.

                      <!-- polymorfa-input-table -->
                      **Value constraints**
                      | Constraint | Accepted input |
                      | --- | --- |
                      | Format | `uri` |
                required:
                  - id
              description: Videos associated with this media.
          required:
            - images
            - videos
          description: Product media gallery entries associated with this catalog item.
        salePrice:
          type: object
          properties:
            price:
              type: string
              description: >-
                Price as a digit string in thousandths of the declared currency
                unit.
            startDate:
              type: string
              description: Specifies start date for this sale price.
            endDate:
              type: string
              description: Specifies end date for this sale price.
          required:
            - price
          description: Structured sale price details for this native business product.
        status:
          type: object
          properties:
            status:
              type: string
              description: Current status of this resource or operation.
            canAppeal:
              type: boolean
              description: Whether appeal.
          required:
            - canAppeal
          description: Structured status details for this native business product.
        variant:
          type: object
          properties:
            availability:
              type: object
              properties:
                listings:
                  type: array
                  items:
                    type: object
                    properties:
                      productId:
                        type: string
                        description: Identifier for the product.
                      available:
                        type: boolean
                        description: Whether this product variant listing is available.
                      options:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Human-readable name for this resource.
                            value:
                              type: string
                              description: Value assigned to this field.
                          required:
                            - name
                            - value
                        description: Selectable options carried by this object.
                    required:
                      - available
                      - options
                  description: Listings associated with this availability.
              required:
                - listings
              description: Structured availability values for this variant.
            listingDetails:
              type: object
              properties:
                description:
                  type: string
                  description: Human-readable description of this resource.
                lowestPrice:
                  type: string
                  description: Specifies lowest price for this listing detail.
                multiPrice:
                  type: string
                  description: Specifies multi price for this listing detail.
              description: Structured listing details values for this variant.
            types:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: Human-readable name for this resource.
                  options:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Value assigned to this field.
                        thumbnail:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Identifier for this resource.
                            originalUrl:
                              type: string
                              format: uri
                              description: >-
                                Original URL supplied before normalization or
                                proxying.


                                <!-- polymorfa-input-table -->

                                **Value constraints**

                                | Constraint | Accepted input |

                                | --- | --- |

                                | Format | `uri` |
                            requestUrl:
                              type: string
                              format: uri
                              description: |-
                                URL for the request.

                                <!-- polymorfa-input-table -->
                                **Value constraints**
                                | Constraint | Accepted input |
                                | --- | --- |
                                | Format | `uri` |
                            originalDimensions:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  minimum: 0
                                  description: |-
                                    Width in pixels.

                                    <!-- polymorfa-input-table -->
                                    **Value constraints**
                                    | Constraint | Accepted input |
                                    | --- | --- |
                                    | Numeric value | `0` or greater |
                                height:
                                  type: integer
                                  minimum: 0
                                  description: |-
                                    Height in pixels.

                                    <!-- polymorfa-input-table -->
                                    **Value constraints**
                                    | Constraint | Accepted input |
                                    | --- | --- |
                                    | Numeric value | `0` or greater |
                              description: >-
                                Structured original dimensions values for this
                                thumbnail.
                          required:
                            - originalDimensions
                          description: Structured thumbnail values for this option.
                      required:
                        - value
                    description: Selectable options carried by this object.
                required:
                  - name
                  - options
              description: Types associated with this variant.
            properties:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: Human-readable name for this resource.
                  value:
                    type: string
                    description: Value assigned to this field.
                required:
                  - name
                  - value
              description: Properties associated with this variant.
          required:
            - availability
            - listingDetails
            - types
            - properties
          description: Structured variant values for this native business product.
      required:
        - id
        - name
        - price
        - currency
        - hidden
        - sanctioned
        - media
        - status
  securitySchemes:
    native__BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_
        prefix) where supported, or short-lived client token (pmfa_ct_ prefix).
        Organization and project keys may be personal or service-account owned
        and enforce selected action scopes. Organization keys cover the team and
        its projects; project tokens stay inside one project. Client tokens stay
        inside their live project and session and enforce their client rules.

````