FOfourthwall
Collections

Get collection by ID or slug

Changed on

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Returns a collection by its ID or slug

get/open-api/v1.0/collections/{collectionIdOrSlug}

Request

  • Base URL
    https://api.fourthwall.com
  • URL
    https://api.fourthwall.com/open-api/v1.0/collections/{collectionIdOrSlug}
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: offer_read
    • or HTTP basic

Path parameters

collectionIdOrSlugstring required

Response

OK

idstring required
shopIdstring required
namestring required
slugstring required
descriptionstring required
availableboolean required
offerIdsstring[] required

Example response

{
  "id": "col_b1EVARkUTcCTSfspQaXr1Q",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "name": "My collection",
  "slug": "my-collection",
  "description": "My collection description"
}

Changes

  • d02dd5a76313Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added PRIVATE discriminator mapping keys to the // response property for the response status

    • info

      added PRIVATE discriminator mapping keys to the // response property for the response status

    • info

      added PRIVATE discriminator mapping keys to the // response property for the response status