Shops

Change a collection

patch/shops/{shopId}/collections/{collectionId}

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/shops/{shopId}/collections/{collectionId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

shopIdstring uuid required
collectionIdstring uuid required

Request body

CollectionInputBody required

See CollectionInput in packages/platform/src/contracts-shop.ts

Response

The collection

idstring uuid required
slugstring required
titlestring required
descriptionstring required
kind'manual' | 'automatic' required
tagstring nullable required

automatic: every active product with this tag

productIdsstring[] required

manual: the products in order

positioninteger required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.