Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /commercetools-categories | Type: Application | PCID required: Yes
Tool Description commercetools_categories_create_categoriesEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Creating a Category produces the CategoryCreated Message. commercetools_categories_create_product_selectionsPOST /product-selections commercetools_categories_create_reviewsPOST /reviews commercetools_categories_create_shopping_listsCreate a ShoppingList in the Project. commercetools_categories_delete_by_idEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. commercetools_categories_delete_by_keyEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. commercetools_categories_delete_product_selections_by_idDeletion will only succeed if the Product Selection is not assigned to any Store . commercetools_categories_delete_product_selections_by_keyDeletion will only succeed if the Product Selection is not assigned to any Store . commercetools_categories_delete_reviews_by_idDELETE /reviews/{ID} commercetools_categories_delete_reviews_by_keyDELETE /reviews/key={key} commercetools_categories_delete_shopping_lists_by_idDeletes a ShoppingList in the Project. commercetools_categories_delete_shopping_lists_by_keyDeletes a ShoppingList in the Project. commercetools_categories_get_by_idEither the scope view_products:{projectKey} or view_categories:{projectKey} is required. commercetools_categories_get_by_keyEither the scope view_products:{projectKey} or view_categories:{projectKey} is required. commercetools_categories_get_product_selections_by_idGET /product-selections/{ID} commercetools_categories_get_product_selections_by_keyGET /product-selections/key={key} commercetools_categories_get_reviews_by_idGET /reviews/{ID} commercetools_categories_get_reviews_by_keyGET /reviews/key={key} commercetools_categories_get_shopping_lists_by_idRetrieves a ShoppingList with the provided id. commercetools_categories_get_shopping_lists_by_keyRetrieves a ShoppingList with the provided key. commercetools_categories_list_categoriesEither the scope view_products:{projectKey} or view_categories:{projectKey} is required. commercetools_categories_list_product_selectionsGET /product-selections commercetools_categories_list_product_selections_products_by_idGET /product-selections/{ID}/products commercetools_categories_list_product_selections_products_by_keyGET /product-selections/key={key}/products commercetools_categories_list_reviewsGET /reviews commercetools_categories_list_shopping_listsRetrieves ShoppingLists in the Project. commercetools_categories_update_categories_by_idEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. commercetools_categories_update_categories_by_keyEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. commercetools_categories_update_product_selections_by_idPOST /product-selections/{ID} commercetools_categories_update_product_selections_by_keyPOST /product-selections/key={key} commercetools_categories_update_reviews_by_idPOST /reviews/{ID} commercetools_categories_update_reviews_by_keyPOST /reviews/key={key} commercetools_categories_update_shopping_lists_by_idUpdates a ShoppingList in the Project using one or more update actions . commercetools_categories_update_shopping_lists_by_keyUpdates a ShoppingList in the Project using one or more update actions .
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Creating a Category produces the CategoryCreated Message.
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline assetsobject[] No — The assets value customobject No — The custom value descriptionobject No — The description value externalIdstring No — External Id keystring No — The key value metaDescriptionobject No — Meta Description metaKeywordsobject No — Meta Keywords metaTitleobject No — Meta Title nameobject Yes — The name value orderHintstring No — Order Hint parentobject No — The parent value slugobject Yes — The slug value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"assets" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The assets value"
},
"custom" : {
"type" : "object" ,
"description" : "The custom value" ,
"properties" : {
"type" : {
"description" : "The type value"
},
"fields" : {
"type" : "object" ,
"description" : "The fields value"
}
},
"required" : [
"type"
]
},
"description" : {
"type" : "object" ,
"description" : "The description value"
},
"externalId" : {
"type" : "string" ,
"description" : "External Id"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"metaDescription" : {
"type" : "object" ,
"description" : "Meta Description"
},
"metaKeywords" : {
"type" : "object" ,
"description" : "Meta Keywords"
},
"metaTitle" : {
"type" : "object" ,
"description" : "Meta Title"
},
"name" : {
"type" : "object" ,
"description" : "The name value"
},
"orderHint" : {
"type" : "string" ,
"description" : "Order Hint"
},
"parent" : {
"description" : "The parent value"
},
"slug" : {
"type" : "object" ,
"description" : "The slug value"
}
},
"required" : [
"PCID" ,
"name" ,
"slug"
]
}
POST /product-selections
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline customobject No — The custom value keystring No — The key value modestring No — The mode value nameobject Yes — The name value typestring No — The type value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"custom" : {
"type" : "object" ,
"description" : "The custom value" ,
"properties" : {
"type" : {
"description" : "The type value"
},
"fields" : {
"type" : "object" ,
"description" : "The fields value"
}
},
"required" : [
"type"
]
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"mode" : {
"type" : "string" ,
"description" : "The mode value" ,
"enum" : [
"Individual" ,
"IndividualExclusion"
]
},
"name" : {
"type" : "object" ,
"description" : "The name value"
},
"type" : {
"type" : "string" ,
"description" : "The type value" ,
"enum" : [
"individual" ,
"individualExclusion"
]
}
},
"required" : [
"PCID" ,
"name"
]
}
POST /reviews
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline authorNamestring No — Author Name customobject No — The custom value customerobject No — The customer value keystring No — The key value localestring No — Locale or language code ratinginteger No — The rating value stateobject No — The state value targetobject No — The target value textstring No — The text value titlestring No — The title value uniquenessValuestring No — Uniqueness Value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"authorName" : {
"type" : "string" ,
"description" : "Author Name"
},
"custom" : {
"type" : "object" ,
"description" : "The custom value" ,
"properties" : {
"type" : {
"description" : "The type value"
},
"fields" : {
"type" : "object" ,
"description" : "The fields value"
}
},
"required" : [
"type"
]
},
"customer" : {
"description" : "The customer value"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"locale" : {
"type" : "string" ,
"description" : "Locale or language code"
},
"rating" : {
"type" : "integer" ,
"description" : "The rating value"
},
"state" : {
"description" : "The state value"
},
"target" : {
"description" : "The target value"
},
"text" : {
"type" : "string" ,
"description" : "The text value"
},
"title" : {
"type" : "string" ,
"description" : "The title value"
},
"uniquenessValue" : {
"type" : "string" ,
"description" : "Uniqueness Value"
}
},
"required" : [
"PCID"
]
}
Create a ShoppingList in the Project.
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline anonymousIdstring No — Anonymous Id businessUnitobject No — Business Unit customobject No — The custom value customerobject No — The customer value deleteDaysAfterLastModificationinteger No — Delete Days After Last Modification descriptionobject No — The description value keystring No — The key value lineItemsobject[] No — Line Items nameobject Yes — The name value slugobject No — The slug value storeobject No — The store value textLineItemsobject[] No — Text Line Items
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"anonymousId" : {
"type" : "string" ,
"description" : "Anonymous Id"
},
"businessUnit" : {
"description" : "Business Unit"
},
"custom" : {
"type" : "object" ,
"description" : "The custom value" ,
"properties" : {
"type" : {
"description" : "The type value"
},
"fields" : {
"type" : "object" ,
"description" : "The fields value"
}
},
"required" : [
"type"
]
},
"customer" : {
"description" : "The customer value"
},
"deleteDaysAfterLastModification" : {
"type" : "integer" ,
"description" : "Delete Days After Last Modification"
},
"description" : {
"type" : "object" ,
"description" : "The description value"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"lineItems" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Line Items"
},
"name" : {
"type" : "object" ,
"description" : "The name value"
},
"slug" : {
"type" : "object" ,
"description" : "The slug value"
},
"store" : {
"description" : "The store value"
},
"textLineItems" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Text Line Items"
}
},
"required" : [
"PCID" ,
"name"
]
}
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value versioninteger Yes — The version value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"ID" ,
"version"
]
}
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Parameters:
Parameter Type Required Default Description keystring Yes — The key value versioninteger Yes — The version value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"key" ,
"version"
]
}
Deletion will only succeed if the Product Selection is not assigned to any Store .
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value versioninteger Yes — The version value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"ID" ,
"version"
]
}
Deletion will only succeed if the Product Selection is not assigned to any Store .
Parameters:
Parameter Type Required Default Description keystring Yes — The key value versioninteger Yes — The version value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"key" ,
"version"
]
}
DELETE /reviews/{ID}
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value dataErasureboolean No — Data Erasure versioninteger Yes — The version value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"dataErasure" : {
"type" : "boolean" ,
"description" : "Data Erasure"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"ID" ,
"version"
]
}
DELETE /reviews/key={key}
Parameters:
Parameter Type Required Default Description keystring Yes — The key value dataErasureboolean No — Data Erasure versioninteger Yes — The version value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"dataErasure" : {
"type" : "boolean" ,
"description" : "Data Erasure"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"key" ,
"version"
]
}
Deletes a ShoppingList in the Project.
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline dataErasureboolean No — Data Erasure versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"dataErasure" : {
"type" : "boolean" ,
"description" : "Data Erasure"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"ID" ,
"version"
]
}
Deletes a ShoppingList in the Project.
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline dataErasureboolean No — Data Erasure versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"dataErasure" : {
"type" : "boolean" ,
"description" : "Data Erasure"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"key" ,
"version"
]
}
Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"ID"
]
}
Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"key"
]
}
GET /product-selections/{ID}
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"ID"
]
}
GET /product-selections/key={key}
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"key"
]
}
GET /reviews/{ID}
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"ID"
]
}
GET /reviews/key={key}
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"key"
]
}
Retrieves a ShoppingList with the provided id.
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"ID"
]
}
Retrieves a ShoppingList with the provided key.
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
}
},
"required" : [
"PCID" ,
"key"
]
}
Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline sortstring[] No — Sort order for results limitinteger No — Maximum number of results to return offsetinteger No — The offset value withTotalboolean No — With Total wherestring[] No — The where value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"sort" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Sort order for results"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of results to return"
},
"offset" : {
"type" : "integer" ,
"description" : "The offset value"
},
"withTotal" : {
"type" : "boolean" ,
"description" : "With Total"
},
"where" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The where value"
}
},
"required" : [
"PCID"
]
}
GET /product-selections
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline sortstring[] No — Sort order for results limitinteger No — Maximum number of results to return offsetinteger No — The offset value withTotalboolean No — With Total wherestring[] No — The where value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"sort" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Sort order for results"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of results to return"
},
"offset" : {
"type" : "integer" ,
"description" : "The offset value"
},
"withTotal" : {
"type" : "boolean" ,
"description" : "With Total"
},
"where" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The where value"
}
},
"required" : [
"PCID"
]
}
GET /product-selections/{ID}/products
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value wherestring[] No — The where value withTotalboolean No — With Total expandstring[] No — Related resources to expand inline limitinteger No — Maximum number of results to return offsetinteger No — The offset value sortstring[] No — Sort order for results
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"where" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The where value"
},
"withTotal" : {
"type" : "boolean" ,
"description" : "With Total"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of results to return"
},
"offset" : {
"type" : "integer" ,
"description" : "The offset value"
},
"sort" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Sort order for results"
}
},
"required" : [
"PCID" ,
"ID"
]
}
GET /product-selections/key={key}/products
Parameters:
Parameter Type Required Default Description keystring Yes — The key value wherestring[] No — The where value withTotalboolean No — With Total expandstring[] No — Related resources to expand inline limitinteger No — Maximum number of results to return offsetinteger No — The offset value sortstring[] No — Sort order for results
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"where" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The where value"
},
"withTotal" : {
"type" : "boolean" ,
"description" : "With Total"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of results to return"
},
"offset" : {
"type" : "integer" ,
"description" : "The offset value"
},
"sort" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Sort order for results"
}
},
"required" : [
"PCID" ,
"key"
]
}
GET /reviews
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline sortstring[] No — Sort order for results limitinteger No — Maximum number of results to return offsetinteger No — The offset value withTotalboolean No — With Total wherestring[] No — The where value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"sort" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Sort order for results"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of results to return"
},
"offset" : {
"type" : "integer" ,
"description" : "The offset value"
},
"withTotal" : {
"type" : "boolean" ,
"description" : "With Total"
},
"where" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The where value"
}
},
"required" : [
"PCID"
]
}
Retrieves ShoppingLists in the Project.
Parameters:
Parameter Type Required Default Description expandstring[] No — Related resources to expand inline sortstring[] No — Sort order for results limitinteger No — Maximum number of results to return offsetinteger No — The offset value withTotalboolean No — With Total wherestring[] No — The where value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"sort" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Sort order for results"
},
"limit" : {
"type" : "integer" ,
"description" : "Maximum number of results to return"
},
"offset" : {
"type" : "integer" ,
"description" : "The offset value"
},
"withTotal" : {
"type" : "boolean" ,
"description" : "With Total"
},
"where" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The where value"
}
},
"required" : [
"PCID"
]
}
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"ID" ,
"actions" ,
"version"
]
}
Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"key" ,
"actions" ,
"version"
]
}
POST /product-selections/{ID}
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"ID" ,
"actions" ,
"version"
]
}
POST /product-selections/key={key}
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"key" ,
"actions" ,
"version"
]
}
POST /reviews/{ID}
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"ID" ,
"actions" ,
"version"
]
}
POST /reviews/key={key}
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"key" ,
"actions" ,
"version"
]
}
Updates a ShoppingList in the Project using one or more update actions .
Parameters:
Parameter Type Required Default Description IDstring Yes — The id value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"ID" : {
"type" : "string" ,
"description" : "The id value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"ID" ,
"actions" ,
"version"
]
}
Updates a ShoppingList in the Project using one or more update actions .
Parameters:
Parameter Type Required Default Description keystring Yes — The key value expandstring[] No — Related resources to expand inline actionsobject[] Yes — The actions value versioninteger Yes — The version value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"key" : {
"type" : "string" ,
"description" : "The key value"
},
"expand" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Related resources to expand inline"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The actions value"
},
"version" : {
"type" : "integer" ,
"description" : "The version value"
}
},
"required" : [
"PCID" ,
"key" ,
"actions" ,
"version"
]
}