SHshopmy

Create Collection

This API route allows a developer application to create a ShopMy collection for a user. This route requires the user to permission your app for the write_collections scope. Partner-created collections are always public.

post/Collections

Request

  • Base URL
    https://api.shopmy.us/v1/Partners
  • URL
    https://api.shopmy.us/v1/Partners/Collections
  • Auth
    API key in header Authorization

Request body

namestring required

Collection name (required)

descriptionstring

Collection description (optional)

Section_idinteger

Section to place the collection in. The section must belong to the authenticated user. If omitted, ShopMy uses the user's first standard shop section when available (optional).

Response

200

successboolean required

Example response

{
  "success": true,
  "collection": {
    "id": 12345,
    "name": "Summer Favorites",
    "description": "My favorite pieces for summer.",
    "image": "https://example.com/collection.jpg",
    "social_links": [
      "https://www.instagram.com/example"
    ],
    "Section_id": 123,
    "url": "https://shopmy.us/collections/12345"
  }
}

Changes

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