> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprimo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Unpin a catalog product from the favorites
> Remove one catalog product from the favorites of one country, so it stops leading the catalog listing. Idempotent — unpinning a product that is not a favorite changes nothing and still answers with the refreshed favorites of that country. This affects what the whole company sees in the catalog, so confirm with the user before calling it. To pin one, use addCatalogFavorite.
Key: WriteScope: Company
## OpenAPI
````yaml https://api.getprimo.com/openapi.json delete /catalog/{countryCode}/products/{productId}/favorite
openapi: 3.1.1
info:
title: Public API - BETA
description: Read docs on https://docs.getprimo.com/
version: '1.0'
contact: {}
servers:
- url: https://api.getprimo.com
security:
- apikey: []
tags: []
paths:
/catalog/{countryCode}/products/{productId}/favorite:
delete:
tags:
- Catalog
summary: Unpin a catalog product from the favorites
description: >-
Remove one catalog product from the favorites of one country, so it
stops leading the catalog listing. Idempotent — unpinning a product that
is not a favorite changes nothing and still answers with the refreshed
favorites of that country. This affects what the whole company sees in
the catalog, so confirm with the user before calling it. To pin one, use
addCatalogFavorite.
operationId: removeCatalogFavorite
parameters:
- name: countryCode
required: true
in: path
schema:
type: string
- name: productId
required: true
in: path
schema:
type: string
responses:
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogFavorites_Output'
components:
schemas:
CatalogFavorites_Output:
type: object
properties:
devices:
type: array
description: Favorite device products, in the order they were curated
items:
type: object
properties:
id:
type: string
name:
type: string
description:
type: string
brand:
anyOf:
- type: string
- type: 'null'
images:
description: Product image URLs
type: array
items:
type: string
variations:
description: >-
Variation dimensions available for this product (e.g. ram,
storage)
type: array
items:
type: string
specifications:
description: Product specifications keyed by specification name
anyOf:
- type: object
propertyNames:
type: string
additionalProperties: {}
- type: 'null'
price:
description: Current price for the requested country
anyOf:
- type: object
properties:
amount:
description: >-
Price amount in the smallest currency unit (e.g.
cents)
type: number
currency:
description: ISO 4217 currency code
type: string
required:
- amount
- currency
additionalProperties: false
- type: 'null'
isDiscontinued:
description: >-
Whether the product is discontinued (deleted or no longer
published)
type: boolean
hasZTD:
description: Whether at least one variant supports zero-touch deployment
type: boolean
hasFastDelivery:
description: Whether at least one variant supports fast delivery
type: boolean
createdAt:
type: string
format: date-time
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt:
type: string
format: date-time
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
required:
- id
- name
- description
- images
- variations
- isDiscontinued
- hasZTD
- hasFastDelivery
- createdAt
- updatedAt
additionalProperties: false
accessories:
type: array
description: Favorite accessory products, in the order they were curated
items:
type: object
properties:
id:
type: string
name:
type: string
description:
type: string
brand:
anyOf:
- type: string
- type: 'null'
images:
description: Product image URLs
type: array
items:
type: string
variations:
description: >-
Variation dimensions available for this product (e.g. ram,
storage)
type: array
items:
type: string
specifications:
description: Product specifications keyed by specification name
anyOf:
- type: object
propertyNames:
type: string
additionalProperties: {}
- type: 'null'
price:
description: Current price for the requested country
anyOf:
- type: object
properties:
amount:
description: >-
Price amount in the smallest currency unit (e.g.
cents)
type: number
currency:
description: ISO 4217 currency code
type: string
required:
- amount
- currency
additionalProperties: false
- type: 'null'
isDiscontinued:
description: >-
Whether the product is discontinued (deleted or no longer
published)
type: boolean
hasZTD:
description: Whether at least one variant supports zero-touch deployment
type: boolean
hasFastDelivery:
description: Whether at least one variant supports fast delivery
type: boolean
createdAt:
type: string
format: date-time
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt:
type: string
format: date-time
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
required:
- id
- name
- description
- images
- variations
- isDiscontinued
- hasZTD
- hasFastDelivery
- createdAt
- updatedAt
additionalProperties: false
required:
- devices
- accessories
additionalProperties: false
securitySchemes:
apikey:
scheme: bearer
bearerFormat: API key
type: http
description: >-
Use your Primo API key in the Authorization header as `Bearer
`.
````