Option Value POST
URI
\n These utilities give developers access to the details of accounts that have installed their app, and\n allow staff credentials to be exchanged for a staff token.\n\t\t\t
\n\t\t'; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = '1'; protected $_resources = [...] }, 'accounting' => class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'accounting'; protected $_domain = NULL; protected $_displayName = 'Accounting'; protected $_baseRelativeUri = 'accounting/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = ''; protected $_resources = [...] }, 'contact' => class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'contact'; protected $_domain = NULL; protected $_displayName = 'Contact'; protected $_baseRelativeUri = 'contact/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\t\t\t\n\t\t\t Contacts include customers, suppliers and staff. The contact service allows you to manage these contacts, the groups they are members of and the tags\n they are associated with, along with lead source information. Contacts play a key role in order management, as all orders and credits are associated\n with contacts.\n\t\t\t
\n\t\t'; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = ''; protected $_resources = [...] }, 'integration' => class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'integration'; protected $_domain = NULL; protected $_displayName = 'Integration'; protected $_baseRelativeUri = 'integration/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The Integration service provides tools for connecting your system or integration to Brightpearl.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = ''; protected $_resources = [...] }, 'order' => class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'order'; protected $_domain = NULL; protected $_displayName = 'Order'; protected $_baseRelativeUri = 'order/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The order service provides functionality for managing the\n sales orders, sales credits, purchase orders and purchase\n credits in your system.\n
\n\n With this service you can create and modify the resources listed below. The primary resource managed\n by this service is the order which represents each type'...; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = ''; protected $_resources = [...] }, 'pricing' => class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'pricing'; protected $_domain = 'pricing'; protected $_displayName = 'Pricing'; protected $_baseRelativeUri = 'pricing/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n
\n The pricing module is used to determine the price of a product\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = ''; protected $_resources = [...] }, 'product' => class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product'; protected $_domain = NULL; protected $_displayName = 'Product'; protected $_baseRelativeUri = 'product/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The product service provides functionality for managing your products.\n With this service you can:\n
- \n
- \n Get information about your products\n Product\n using an\n \n
\n\t\t\tThe warehouse service provides functionality for managing the availability\n\t\t\tand location of stock. With this service you can:\n\t\t\t\t
- \n\t\t\t\t\t
- \n\t\t\t\t\t\tCreate a new Warehouse or a\n\t\t\t\t\t\tLocation\n\t\t\t\t\t\t(like an aisle or shelf).\n\t\t\t\t\t \n\t\t\t\t\t
- \n\t\t\t\t\t\tReceive stock from a supplier with a\n\t\t\t\t\t\tGoods-In Note.\n\t\t\t\t\t \n\t\t\t\t\t
- \n\t\t\t\t\t\tManage the proc'...; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = ''; protected $_resources = [...] }], $renderer = class DocGen_Renderer_DocumentationRenderer { protected $_workingDirectories = class DocGen_WorkingDirectories { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_workingDir = '//working'; protected $_artifactDir = '//working/artifacts'; protected $_outputDir = '/opt/docs'; protected $_resourcesDir = '//resources' }; protected $_writer = class DocGen_Writer { protected $_writers = [...] }; protected $_pageTitleSuffix = 'Brightpearl API'; protected $_uriGenerator = class DocGen_Renderer_Helper_UriGenerator { }; protected $_modelRenderer = ['description' => class DocGen_Renderer_Model_Description { ... }, 'example' => class DocGen_Renderer_Model_Examples { ... }]; protected $_renderingContext = class DocGen_Renderer_RenderingContext { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_highlightBrokenLinks = ''; protected $_services = [...]; protected $_searches = [...]; protected $_uriGenerator = class DocGen_Renderer_Helper_UriGenerator { ... } }; protected $_resourceCopier = class DocGen_Resource_Copy_FileSystem { }; protected $_renderingPreferences = class DocGen_Dto_RenderingPreferences { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_languageCode = 'en'; protected $_countryCode = 'gb'; protected $_allowSearchEngineIndexing = NULL; protected $_enableAnalytics = NULL } }, $outputDir = '/opt/docs') /library/DocGen/Renderer/DocumentationRenderer.php:111
2.2915 6798288 5. DocGen_Renderer_Service->_renderResources($resources = ['brand' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'brand'; protected $_domain = NULL; protected $_displayName = 'Brand'; protected $_baseRelativeUri = 'product/brand/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n
\n The brand resource allows you to retrieve and create brands.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'brightpearl-category' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'brightpearl-category'; protected $_domain = NULL; protected $_displayName = 'Brightpearl Category'; protected $_baseRelativeUri = 'product/brightpearl-category/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The Brightpearl Category resource allows you to retrieve and create\n Brightpearl\n Categories.\n
\n\n To organise products in Brightpearl they need to be placed within Categories.\n Categories are organised hierarchically in Brightpearl. The\n parentId field\n defines the\n relationship between Categories. '...; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'channel' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'channel'; protected $_domain = NULL; protected $_displayName = 'Channel'; protected $_baseRelativeUri = 'product/channel/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n
\n The Channel resource allows you to retrieve Channels.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'channel-brand' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'channel-brand'; protected $_domain = NULL; protected $_displayName = 'Channel brand'; protected $_baseRelativeUri = 'product/channel-brand/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The channel brand resource defines the public-facing identity of a channel. It allows you specify a\n brand-specific address, logo, email/telephone, message/invoice templates and financial details.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'collection' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'collection'; protected $_domain = NULL; protected $_displayName = 'Collection'; protected $_baseRelativeUri = 'product/collection/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n Collection is a sub-resource of brand. Every collection\n belongs to a brand. While every product in Brightpearl must have a brand they do not need to\n have a collection. When a product does have a collection that collection must belong to the\n product\'s brand.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'discount' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'discount'; protected $_domain = NULL; protected $_displayName = 'Discount'; protected $_baseRelativeUri = 'product/discount/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'discount-contact-usage' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'discount-contact-usage'; protected $_domain = NULL; protected $_displayName = 'Discount contact usage'; protected $_baseRelativeUri = 'product/discount-contact-usage/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The discount contact usages resource is a read-only convenience endpoint to easily obtain the current\n number of usages for a discount by a specific contact.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'discount-status' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'discount-status'; protected $_domain = NULL; protected $_displayName = 'Discount status'; protected $_baseRelativeUri = 'product/discount-status/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'discount-total-usage' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'discount-total-usage'; protected $_domain = NULL; protected $_displayName = 'Discount total usage'; protected $_baseRelativeUri = 'product/discount-total-usage/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The discount total usages resource is a read-only convenience endpoint to easily obtain the current\n number of usages for a discount.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'discount-usage' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'discount-usage'; protected $_domain = NULL; protected $_displayName = 'Discount usage'; protected $_baseRelativeUri = 'product/discount-usage/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'gtin' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'gtin'; protected $_domain = NULL; protected $_displayName = 'GTIN'; protected $_baseRelativeUri = 'product/gtin/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'image' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'image'; protected $_domain = NULL; protected $_displayName = 'Image'; protected $_baseRelativeUri = 'product/image/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'image-lookup' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'image-lookup'; protected $_domain = NULL; protected $_displayName = 'Image Lookup'; protected $_baseRelativeUri = 'product/image-lookup/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'option' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'option'; protected $_domain = NULL; protected $_displayName = 'Option'; protected $_baseRelativeUri = 'product/option/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The option resource allows you to retrieve and create product options.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'option-value' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'option-value'; protected $_domain = NULL; protected $_displayName = 'Option Value'; protected $_baseRelativeUri = 'product/option-value/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The option value resource allows you to retrieve and create product option values.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'price-list' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'price-list'; protected $_domain = NULL; protected $_displayName = 'Price List'; protected $_baseRelativeUri = 'product/price-list/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The Price List resource allows you to retrieve Price Lists.\n
\n\n There are two types of Price List:\n
- \n
- SELL: This indicates that the Price List in question is a Price List used to sell\n Products.\n \n
- BUY: This indicates that the Price List in question is a Price List used to buy Prod'...; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'primary-supplier' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'primary-supplier'; protected $_domain = NULL; protected $_displayName = 'Product Primary Supplier'; protected $_baseRelativeUri = 'product/primary-supplier/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n
\n The product primary supplier resource allows you to delete the primary supplier id for given products.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product'; protected $_domain = NULL; protected $_displayName = 'Product'; protected $_baseRelativeUri = 'product/product/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n There are a few types of product:\n
\n\n Normal products:\n\n These are simple products with no variations in size or\n colour. They can be tangible (such as a coffee mug) or not; for\n example a service\n such as “Setup fee” could be a normal product. The former must have\n “manage stock” set to yes and the lat'...; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'product-allocation' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'product-allocation'; protected $_domain = NULL; protected $_displayName = 'Product Allocation'; protected $_baseRelativeUri = 'product/product-allocation/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-bundle' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-bundle'; protected $_domain = NULL; protected $_displayName = 'Product Bundle'; protected $_baseRelativeUri = 'product/product-bundle/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n
\n This resource returns a list of the bundles that contain a given product, and recursively any bundles\n that contain those bundles.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-custom-field' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-custom-field'; protected $_domain = NULL; protected $_displayName = 'Product Custom Field'; protected $_baseRelativeUri = 'product/product-custom-field/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n Product custom fields are the user-defined data held against a Brightpearl product. Several data types are available.\n This endpoint allows you to retrieve the custom fields of multiple products.\n
\n\n If you want to see what fields are available to a product then you can make a\n product custom field metadata GET<'...; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-custom-field-metadata' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-custom-field-metadata'; protected $_domain = NULL; protected $_displayName = 'Custom Field Metadata'; protected $_baseRelativeUri = 'product/product-custom-field-metadata/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n
\n '; protected $_descriptionXml = class DOMElement { public $schemaTypeInfo = NULL; public $tagName = 'description'; public $className = ''; public $id = ''; public $firstElementChild = '(object value omitted)'; public $lastElementChild = '(object value omitted)'; public $childElementCount = 1; public $previousElementSibling = NULL; public $nextElementSibling = NULL; public $nodeName = 'description'; public $nodeValue = '\n \n The product service provides functionality for managing your products.\n With this service you can:\n \n \n Get information about your products\n Product\n using an\n \n \n \n '; public $nodeType = 1; public $parentNode = '(object value omitted)'; public $parentElement = '(object value omitted)'; public $childNodes = '(object value omitted)'; public $firstChild = '(object value omitted)'; public $lastChild = '(object value omitted)'; public $previousSibling = '(object value omitted)'; public $nextSibling = '(object value omitted)'; public $attributes = '(object value omitted)'; public $isConnected = TRUE; public $ownerDocument = '(object value omitted)'; public $namespaceURI = NULL; public $prefix = ''; public $localName = 'description'; public $baseURI = '/opt/build/docs/product/src/main/resources/api-doc/service.xml'; public $textContent = '\n \n The product service provides functionality for managing your products.\n With this service you can:\n \n \n Get information about your products\n Product\n using an\n \n \n \n ' }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 1; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = ''; protected $_resources = ['brand' => class DocGen_Model_Resource { ... }, 'brightpearl-category' => class DocGen_Model_Resource { ... }, 'channel' => class DocGen_Model_Resource { ... }, 'channel-brand' => class DocGen_Model_Resource { ... }, 'collection' => class DocGen_Model_Resource { ... }, 'discount' => class DocGen_Model_Resource { ... }, 'discount-contact-usage' => class DocGen_Model_Resource { ... }, 'discount-status' => class DocGen_Model_Resource { ... }, 'discount-total-usage' => class DocGen_Model_Resource { ... }, 'discount-usage' => class DocGen_Model_Resource { ... }, 'gtin' => class DocGen_Model_Resource { ... }, 'image' => class DocGen_Model_Resource { ... }, 'image-lookup' => class DocGen_Model_Resource { ... }, 'option' => class DocGen_Model_Resource { ... }, 'option-value' => class DocGen_Model_Resource { ... }, 'price-list' => class DocGen_Model_Resource { ... }, 'primary-supplier' => class DocGen_Model_Resource { ... }, 'product' => class DocGen_Model_Resource { ... }, 'product-allocation' => class DocGen_Model_Resource { ... }, 'product-bundle' => class DocGen_Model_Resource { ... }, 'product-custom-field' => class DocGen_Model_Resource { ... }, 'product-custom-field-metadata' => class DocGen_Model_Resource { ... }, 'product-customfield' => class DocGen_Model_Resource { ... }, 'product-group' => class DocGen_Model_Resource { ... }, 'product-identity' => class DocGen_Model_Resource { ... }, 'product-image-association' => class DocGen_Model_Resource { ... }, 'product-option-value' => class DocGen_Model_Resource { ... }, 'product-price' => class DocGen_Model_Resource { ... }, 'product-status' => class DocGen_Model_Resource { ... }, 'product-supplier' => class DocGen_Model_Resource { ... }, 'product-type' => class DocGen_Model_Resource { ... }, 'product-type-option-association' => class DocGen_Model_Resource { ... }, 'promotion' => class DocGen_Model_Resource { ... }, 'promotion-status' => class DocGen_Model_Resource { ... }, 'season' => class DocGen_Model_Resource { ... }] }) /library/DocGen/Renderer/Service.php:51 2.4331 6933992 6. DocGen_Renderer_Service->_renderHttpMethods($httpMethods = ['get' => class DocGen_Model_HttpMethod { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'get'; protected $_domain = NULL; protected $_displayName = 'GET'; protected $_baseRelativeUri = 'product/option-value/get.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n Custom fields may be configured to allow you to hold additional information against your products.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-customfield' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-customfield'; protected $_domain = NULL; protected $_displayName = 'Custom Field'; protected $_baseRelativeUri = 'product/product-customfield/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n Product custom fields are the user-defined data held against a Brightpearl product. Several data types are available.\n
\n\n If you want to see what fields are available to a product then you can make a\n product custom field metadata GET request.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-group' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-group'; protected $_domain = NULL; protected $_displayName = 'Product Group'; protected $_baseRelativeUri = 'product/product-group/index.html'; protected $_shortDescription = 'Product groups allow variants to be easily managed'; protected $_descriptionHtmlFragment = '\n\n Product groups allow variants to be easily managed. Activating the grid format for a product group will make batch adding variants on to orders easier to handle.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-identity' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-identity'; protected $_domain = NULL; protected $_displayName = 'Product Identity'; protected $_baseRelativeUri = 'product/product-identity/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n Update product identities (SKU, EAN, UPC, MPN, and ISBN)\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-image-association' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'product-image-association'; protected $_domain = NULL; protected $_displayName = 'Product Image Association'; protected $_baseRelativeUri = 'product/product-image-association/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-option-value' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-option-value'; protected $_domain = NULL; protected $_displayName = 'Product option value'; protected $_baseRelativeUri = 'product/product-option-value/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n This resource represents the option values associated with a product.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-price' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-price'; protected $_domain = NULL; protected $_displayName = 'Product Price'; protected $_baseRelativeUri = 'product/product-price/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The product price resource represents prices for products\n on price lists.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-status' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'product-status'; protected $_domain = NULL; protected $_displayName = 'Product Status'; protected $_baseRelativeUri = 'product/product-status/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-supplier' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-supplier'; protected $_domain = NULL; protected $_displayName = 'Product Supplier'; protected $_baseRelativeUri = 'product/product-supplier/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The product supplier resource allows you to retrieve and modify the suppliers for given products.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'product-type' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-type'; protected $_domain = NULL; protected $_displayName = 'Product Type'; protected $_baseRelativeUri = 'product/product-type/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The Product Type resource allows you to retrieve and create Product Types.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'product-type-option-association' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product-type-option-association'; protected $_domain = NULL; protected $_displayName = 'Product Type Option Association'; protected $_baseRelativeUri = 'product/product-type-option-association/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n This resource represents the relationship between a\n Product Type\n and a\n Option\n .\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'promotion' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'promotion'; protected $_domain = NULL; protected $_displayName = 'Promotion'; protected $_baseRelativeUri = 'product/promotion/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = class DocGen_Model_ResourceSearch { ... } }, 'promotion-status' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = NULL; protected $_normalisedName = 'promotion-status'; protected $_domain = NULL; protected $_displayName = 'Promotion status'; protected $_baseRelativeUri = 'product/promotion-status/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = NULL; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = NULL; protected $_depth = 2; protected $_isPublic = FALSE; protected $_isVisible = FALSE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }, 'season' => class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'season'; protected $_domain = NULL; protected $_displayName = 'Season'; protected $_baseRelativeUri = 'product/season/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The season resource allows you to retrieve and create seasons.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { ... }; protected $_displayNamePlural = NULL; protected $_httpMethods = [...]; protected $_primarySearch = NULL }], $outputDir = '/opt/docs/product', $service = class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [0 => '_resources', 1 => '_normalisedName', 2 => '_domain', 3 => '_displayName', 4 => '_baseRelativeUri', 5 => '_shortDescription', 6 => '_descriptionHtmlFragment', 7 => '_descriptionXml', 8 => '_internalNotesXml', 9 => '_internalNotesHtmlFragment', 10 => '_depth', 11 => '_isPublic', 12 => '_isVisible', 13 => '_index', 14 => '__methodRegEx', 15 => '__classVars']; protected $_normalisedName = 'product'; protected $_domain = NULL; protected $_displayName = 'Product'; protected $_baseRelativeUri = 'product/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The product service provides functionality for managing your products.\n With this service you can:\n
- \n
- \n Get information about your products\n Product\n using an\n \n
\n Returns the ID of the option value, the ID of its associated option, the option name, and its\n sort order.\n
\n '; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentResource = class DocGen_Model_Resource { ... }; protected $_examplesXml = [...]; protected $_examplesHtmlCollection = [...]; protected $_uriTemplate = NULL; protected $_uriTemplateScope = 'account'; private $apiVersion = NULL }, 'post' => class DocGen_Model_HttpMethod { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'post'; protected $_domain = NULL; protected $_displayName = 'POST'; protected $_baseRelativeUri = 'product/option-value/post.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n This message allows you to add an option value for an existing product option.\n
\n\n In order for the option value to be successfully added,\n
- \n
- \n the optionId must be valid and\n \n
- \n the optionValueName must be uni'...; protected $_descriptionXml = class DOMElement { ... }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentResource = class DocGen_Model_Resource { ... }; protected $_examplesXml = [...]; protected $_examplesHtmlCollection = [...]; protected $_uriTemplate = NULL; protected $_uriTemplateScope = 'account'; private $apiVersion = NULL }], $resource = class DocGen_Model_Resource { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [0 => '_parentService', 1 => '_displayNamePlural', 2 => '_httpMethods', 3 => '_primarySearch', 4 => '_normalisedName', 5 => '_domain', 6 => '_displayName', 7 => '_baseRelativeUri', 8 => '_shortDescription', 9 => '_descriptionHtmlFragment', 10 => '_descriptionXml', 11 => '_internalNotesXml', 12 => '_internalNotesHtmlFragment', 13 => '_depth', 14 => '_isPublic', 15 => '_isVisible', 16 => '_index', 17 => '__methodRegEx', 18 => '__classVars']; protected $_normalisedName = 'option-value'; protected $_domain = NULL; protected $_displayName = 'Option Value'; protected $_baseRelativeUri = 'product/option-value/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n
\n The option value resource allows you to retrieve and create product option values.\n
\n '; protected $_descriptionXml = class DOMElement { public $schemaTypeInfo = NULL; public $tagName = 'description'; public $className = ''; public $id = ''; public $firstElementChild = '(object value omitted)'; public $lastElementChild = '(object value omitted)'; public $childElementCount = 1; public $previousElementSibling = NULL; public $nextElementSibling = NULL; public $nodeName = 'description'; public $nodeValue = '\n \n The option value resource allows you to retrieve and create product option values.\n \n '; public $nodeType = 1; public $parentNode = '(object value omitted)'; public $parentElement = '(object value omitted)'; public $childNodes = '(object value omitted)'; public $firstChild = '(object value omitted)'; public $lastChild = '(object value omitted)'; public $previousSibling = '(object value omitted)'; public $nextSibling = '(object value omitted)'; public $attributes = '(object value omitted)'; public $isConnected = TRUE; public $ownerDocument = '(object value omitted)'; public $namespaceURI = NULL; public $prefix = ''; public $localName = 'description'; public $baseURI = '/opt/build/docs/product/src/main/resources/api-doc/resource/option-value.xml'; public $textContent = '\n \n The option value resource allows you to retrieve and create product option values.\n \n ' }; protected $_internalNotesXml = NULL; protected $_internalNotesHtmlFragment = ''; protected $_depth = 2; protected $_isPublic = TRUE; protected $_isVisible = TRUE; protected $_index = NULL; protected $_parentService = class DocGen_Model_Service { protected $__methodRegEx = '/^(get|set)([A-Z]{1}[A-Za-z]{0,})$/'; protected $__classVars = [...]; protected $_normalisedName = 'product'; protected $_domain = NULL; protected $_displayName = 'Product'; protected $_baseRelativeUri = 'product/index.html'; protected $_shortDescription = NULL; protected $_descriptionHtmlFragment = '\n\n The product service provides functionality for managing your products.\n With this service you can:\n
- \n
- \n Get information about your products\n Product\n using an\n \n
\n The product service provides functionality for managing your products.\n With this service you can:\n
- \n
- \n Get information about your products\n Product\n using an\n \n
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}/product-serviceRefer to our documentation on URI syntax for more information on how to construct URIs.
Description
This message allows you to add an option value for an existing product option.
In order for the option value to be successfully added,
- the optionId must be valid and
- the optionValueName must be unique.
The response is the ID of the created option value.
| Field | Description | Required | Maximum length |
|---|---|---|---|
| optionValueName | The name of the option value. | Yes | 32 |
| sortOrder | he natural sort order of the option value - e.g. color would be sorted XS, S, M, etc., rather than alphabetically. | No (default 0) |
Example
Request URI
/option/1/value Request body
{
"optionValueName": "Aubergine",
"sortOrder": 5
}Response
{
"response": 14
}