{"info":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","description":"

Documentation moved to docs.propeller-commerce.com

\n
This documentation is OUTDATED and will be removed shortly, please go to our new documentation site at https://docs.propeller-commerce.com
\n

The Propeller REST API is based on resource-oriented URL's, returns JSON-encoded responses and uses standard HTTP response codes, authentication and HTTP methods. The main goal of the REST API is efficiently importing/exporting large amounts of data in/out of the Propeller platform.

HTTP methods

Propeller REST API supports POST, GET, PATCH, and DELETE HTTP methods.

Authentication

The REST API uses the oAuth 2.0 client credentials grant type for authentication, every API requests needs a valid access token.

Request an access token

Request an access token by executing a POST request to the token endpoint. This POST request should include the Client id and Client secret.
\n
A successful access token request will return the following result:
\n

{\n  \"refresh_token_expires_in\": \"0\",\n  \"api_product_list\": \"[Propeller REST APIs]\",\n  \"api_product_list_json\": [\n    \"Propeller REST APIs\"\n  ],\n  \"organization_name\": \"propeller-platform-prod\",\n  \"developer.email\": \"developer@propel.us\",\n  \"token_type\": \"BearerToken\",\n  \"issued_at\": \"1646873717224\",\n  \"client_id\": \"veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT\",\n  \"access_token\": \"ARAo4GjuI1bGSyenSKx5oYfFGuFQ\",\n  \"application_name\": \"a1ca275a-2abb-4bd3-82b0-3ae699d75e40\",\n  \"scope\": \"\",\n  \"expires_in\": \"1899\",\n  \"refresh_count\": \"0\",\n  \"status\": \"approved\"\n}\n\n

3. Parse the access_token value from this result and use it as a bearer token in subsequent API requests.

4. After 30 minutes the requested access_token expires and a new token needs to be requested.

Lookup keys

The REST API offers multiple ways to identify resources. In Propeller terminology these are called lookup keys. For example: a product can be identified by its Propellor internal idbut also by an sku. A sku however, is not guaranteed to be unique in the catalogue, as multiple products with the same sku can exist. If multiple resources are found based on the lookup key / value combination the result of the request will be an error. In case of multiple products with the same sku a GET or PATCH request to this product will result in an error.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Lookup Key	Explanation
id	Unique Propeller id of an object
externalId	Unique external id
sourceId/ source	External system unique id to a Propeller resource. `sourceId` always needs to be combined with a `source`. Source is typically the name of a supplier or ERP system the data originates from.
sku	Stock-keeping unit code referencing a product
supplierCode / supplier	Code of a supplier referencing a product
code	Code referencing any other resource (e.g. a pricesheet)

Source ID/ Source lookup key is most commonly used in Bulk endpoints. If you're creating/ updating products from an external system, the name of that system would typically be the source and sourceId would be the product's id or code in that system. This id should be unique in that system and the combination source/sourceId is unique in Propeller. When using the GET, DELETE, UPDATE endpoints with lookup key sourceId you can use it without source, but if multiple resources are found you will get an error. In that case use source as well.

Supplier code / supplier is another common way of looking up products. The difference between the sourceId is that the combination does not have to be unique. When it's not and you try to use the GET, UPDATE, DELETE endpoints you will get an error that multiple resources have been found.

Expanding resources

Some resources allow to request additional information as an expanded resource by using the expands request parameter. This parameter is available on all GET REST API requests and applies to the response of that request only.

In many cases, an object contains a related object in its response properties. For example, an Orderitem may have an associated Product id. Those objects can be expanded inline with the expands request parameter.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Expand parameter
orderItems	expands the `order` resource with `orderItems`
orderItems.product	expands the `orderItems` resource with the `product` resource
translation	expands translated fields for all available languages.
inventoryBalance	expands all inventory resources for a `product`
defaultProduct	expand the `cluster` or `option` resuorce with the default `product` resource

Pagination

Querying resources and especially retrieving a lot of data can be potentially really expensive. Therefor, endpoints that retrieve a lot of results are paginated. Use page and offset query parameters to request a certain page of the result in GET endpoints. When using search endpoints (POST HTTP method), page and offset are part of the payload.

Page

You can request a certain page of the result using the page query/ payload parameter.

Offset

You can set the maximum number of results to return using the offset query/ payload parameter. The minimum value is 1 and the maximum can differ per API. This is specified in more details in endpoints that support pagination. The default offset on most endpoints is 12.

Response

This response retrieves 2 results in the data, the number of results per page is 2 and page requested is 1. total is the number of records for the page requested, while itemsFound is the total number of results.

{\n  \"data\": [\n    {\n      id: 56897\n    },\n    {\n      id: 36975\n    }\n  ],\n  \"messages\": [\n    \"Completed\"\n  ],\n  \"start\": 1,\n  \"pages\": 20,\n  \"total\": 2,\n  \"offset\": 2,\n  \"itemsFound\": 35,\n  \"end\": 2,\n  \"page\": 1\n}\n\n

Errors

This section describes error codes used in the Propeller platform REST APIs and their meaning. For details about the API-specific error-codes, consult the documentation dedicated to that API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
10005	InvalidJSONPayload	400	Invalid JSON Payload	JSON provided in payload is not valid
10006	InvalidLookupKey	400	Invalid lookup key	Lookup key is not supported in the specific API. Check API specific lookup keys
10007	SchemaValidationException	400	Schema Validation Error	JSON schema validation. Response contains the details of the issue
10008	NotFound	404	Resource not found	Resource deleted, non-existing or insufficient permissions
10015	PaginatedResponseException	400	Pagination not properly initialized	`offset` or `page` are not initialized properly. These should be positive integers. Possible maximum limit exceeded on `offset`
10016	LookupKeyNotFound	400	Lookup key not found in payload	Bulk endpoints by a certain lookup key require that the lookup key is provided in the payload
10017	PayloadValidationError	400	Payload validation error	Server side validation of the payload. Response contains the details of the issue
10018	TranslationNotFound	404	Translation not found	Resource deleted, non-existing or insufficient permissions
10019	WarehouseNotFound	404	Warehouse not found	Resource deleted, non-existing or insufficient permissions
10020	WarehouseInvalidConfiguration	400	Warehouse invalid configuration	Warehouse not properly configured, e.g. not a pick up location

Error response

When an API call results in an error, the response contains the error property which is an object with the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
code	string	Error code. Generic error codes are listed here, while API specific error codes are listed in each API
status	integer	Status code
type	string	Error type. Generic error types are listed here, while API specific error types are listed in each API
messages	array[string]	An array of error messages
moreInfo	string	URL to a page containing details about the error (under construction)

Example error response:

{\n  \"error\": {\n    \"code\": 80006,\n    \"status\": 404,\n    \"type\": \"ProductNotFound\",\n    \"messages\": [\n      \"Product with id [481189] not found\"\n    ],\n    \"moreInfo\": \"https://www.propel.us/docs/errors/80006\"\n  }\n}\n\n

Localized String

A localized string is a JSON object used for fields that are translatable. A localized string has two properties: to indicate the language as per ISO 639-1 and the value of the translated field in that language.

{\n    \"language\": \"EN\",\n    \"value\": \"\"\n}\n\n

Bulk endpoints

Bulk endpoints allow for an efficient way of importing/updating large amounts of data with just a single API call. Traditional REST API functionality would allow for a single resource (e.g. a product or user) to be created and a second API request to update this resource. Creating and/or updating multiple resources would mean executing multiple API requests. Working with larger number of resources means this approach would generate a significant number of API calls resulting in inefficient use of resources and import processes taking a lot of time.

The Propeller REST API offers \"bulk\" functionality to efficiently import/update resources. A bulk request typically contains a payload of multiple resources of a single type (e.g. product, user, category or inventory). Based on the lookupKey Propeller will decide if a resource needs to be created or updated.

Bulk endpoints take away the need for multiple API calls to determine if a resource needs to be created or updated and allow for creating/updating multiple resources in on API request.

Directives

Directives are a powerful Propeller REST APIs concept only used in bulk endpoints. Use direcitves for actions that are otherwise only doable via a lot of single endpoint API requests. Directives concept is easiest to understand via use cases.

Let's assume a large number of products is being created/ updated using the Product Bulk endpoint and Propeller's back office is used to maintain some of the data, e.g. product names. When products are created via the bulk endpoint they should not be created with an empty product name. That name can later be changed and we don't want to overwrite it. If it were a single resource endpoint, the GET endpoint could be used to check if the product exists, find the name, compare it, etc. That is not really efficient on a large scale. This is where skipIfNotEmpty directive comes handy. Use this directive when you only want to set a field with the value from the payload if it's current value is an empty string.
\n
Another use case is using Propeller to move resources in a different parent container that the one they were originally created in. Let's assume you have a list of products that belong in certain categories and those products are created via the Bulk endpoints. If you decide to maintain the catalogue structure from within Propeller you would typically move products around manually or via Propeller's rule engine. To avoid a Bulk endpoint would move them back to their original endpoint, use the skipMoveOnUpdate directive.
\n
When creating categories/ product translations you typically have a list of all the active translations you want the resource to be translated in. When using a single resource endpoint you can delete translations one by one, but in the Bulk endpoints use mergeTranslationsOnUpdate to reset i.e. delete the ones that are not in the payload.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing resource that are not empty	array of field names, API specific e.g. for `products` : `names`, `descriptions`, etc.
skipMoveOnUpdate	On update, skip moving an existing resource in the parent resource provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a resource that are not provided in the payload	empty array
skipCreate	Skip creating new, only update existing resources	empty array

Usecases

Usergroups - users bulk import

The user rest api is typically used in a B2B environment where a predefined set of customers is allowed access to a webshop / portal. Typically those customers are managed in an ERP and/or CRM system and in order for these customers to have access to the webshop, they need to have an account in Propeller meaning these customers need to be imported into Propeller.

A common way for an ERP/CRM system to handle the concept of customers is to have an entity called customer/debtor or relation and within this entity there are one or multiple contacts. The customer/debtor in this case is a company/organization and has a unique debtorId . The contacts are typically persons within the organization with each their own e-mail address/telephone number and multiple different invoice, delivery and visiting addresses.

A typical way to get the ERP / CRM customers into Propeller is to create a Propeller usergroup for each customer and within this usergroup, for each contact, a Propeller user .

Most of the time the number of customers/contacts which need to be imported will be multiple thousands (if not more). In these cases it is important to use the user and usergroup bulk endpoints, these make sure creating/updating the usergroups / users / addresses / attributes is done in efficiently.

To create the usergroups and users in Propellor two different bulk endpoints need to be used:

the usergroup bulk endpoint
\n
the user bulk endpoint
\n

Via the usegroup bulk endpoint multiple usergroups representing companies will be created:

{\n    \"usergroups\": [\n        {\n           \"sourceId\": \"x-123\",\n           \"source\": \"MBC\",\n           \"language\": \"EN\",\n           \"parent\": {\n                \"sourceId\": 999112000\n                \"source\": \"MBC\"\n            },\n            \"name\": \"Company X\"\n        },\n        {\n            \"sourceId\": \"y-456\",\n            \"source\": \"MBC\",\n            \"language\": \"EN\",\n            \"parent\": {\n                \"sourceId\": 999112000\n                \"source\": \"MBC\"\n            },\n            \"name\": \"Company Y\"\n         },\n        {\n            \"sourceId\": \"z-789\",\n            \"source\": \"MBC\",\n            \"language\": \"EN\",\n            \"parent\": {\n                \"sourceId\": 999112000\n                \"source\": \"MBC\"\n            },\n            \"name\": \"Company Z\"\n        }\n    ]\n}\n\n

The above usergroup bulk endpoint will create or update three usergroups. In this case we use the sourceId / source combination as lookupKey / lookupValue combination. When using the sourceId / source combination as lookup key, it's possible to identify resources in Propeller based on keys / identifiers from the ERP / CRM system. In the usergroup example, the source of the data is Microsoft Business Central (MBC) and the sourceId is a unque id / code for a certain customer / organization in Microsoft business central. The combination of the source and sourceId field will make sure there is only one resource found when referencing a usergroup based on these lookup values.

In advanced setup's its possible to import resources (e.g. customers / contacts) from multiple sources, If usergroups / users would also be imported from a second ERP / CMS system there is a change the sourceId would not be available anymore since it is used already by the first import. Because Propeller uses the combination of sourceId / source to uniquely identify a resource it is possible to import data from multiple different sources using the same sourceId's. A second usergroup import from e.g. Exact Globe could look like this:

{\n    \"usergroups\": [\n        {\n           \"sourceId\": \"x-123\",\n           \"source\": \"EXACTGLOBE\",\n           \"language\": \"EN\",\n           \"parent\": {\n                \"sourceId\": \"999112000\"\n                \"source\": \"EXACTGLOBE\"\n            },\n            \"name\": \"Company XX\"\n        },\n        {\n            \"sourceId\": \"y-456\",\n            \"source\": \"EXACTGLOBE\",\n            \"language\": \"EN\",\n            \"parent\": {\n                \"sourceId\": \"999112000\"\n                \"source\": \"EXACTGLOBE\"\n            },\n            \"name\": \"Company YY\"\n         },\n        {\n            \"sourceId\": \"z-789\",\n            \"source\": \"EXACTGLOBE\",\n            \"language\": \"EN\",\n            \"parent\": {\n                \"sourceId\": \"999112000\"\n                \"source\": \"EXACTGLOBE\"\n            },\n            \"name\": \"Company ZZ\"\n        }\n    ]\n}\n\n

In this case the sourceId's from MBC and Exact Globe are the same but because Propeller uses the additional field source to identify a resource it is possible to keep using the identifiers generated by the ERP / CRM.

Once the usergroups are created the users can be created via the user bulk endpoint. To make sure a user is created inside the correct usergroup within the user resource a parent object is added pointing to the usergroup using the source / sourceId of the usergroup

{\n    \"users\": [\n        {\n            \"source\": \"MBC\",\n            \"sourceId\": \"3002196\",\n            \"language\": \"NL\",\n            \"parent\": {\n                \"sourceId\": \"x-123\",\n                \"source\" : \"MBC\"\n            },\n            \"firstName\": \"Miles\",\n            \"middleName\": \"\",\n            \"lastName\": \"McCoy\",\n            \"debtorId\": 12345,\n            \"login\" : \"miles@xx.com\"\n            \"company\" : \"Company X\"\n            \"email\": \"miles@xx.com\",\n            \"mobile\": \"001445888\",\n            \"phone\": \"001445888\",\n            \"title\": \"Mr.\",\n            \"gender\": \"M\"\n        },\n        {\n            \"source\": \"MBC\",\n            \"sourceId\": \"3002197\",\n            \"language\": \"NL\",\n            \"parent\": {\n                \"sourceId\": \"x-123\",\n                \"source\" : \"MBC\"\n            },\n            \"firstName\": \"Bernie\",\n            \"middleName\": \"\",\n            \"lastName\": \"Sawer\",\n            \"debtorId\": 12345,\n            \"login\" : \"bernie@xx.com\"\n            \"company\": \"Company X\",\n            \"email\": \"bernie@xx.com\",\n            \"mobile\": \"001445888\",\n            \"phone\": \"001445888\",\n            \"title\": \"Mr.\",\n            \"gender\": \"M\"\n        },\n        {\n            \"source\": \"MBC\",\n            \"sourceId\": \"3002200\",\n            \"language\": \"NL\",\n            \"parent\": {\n                \"sourceId\": \"x-456\",\n                \"source\" : \"MBC\"\n            },\n            \"firstName\": \"Delia\",\n            \"middleName\": \"Ferdi\",\n            \"lastName\": \"Finney\",\n            \"debtorId\": 67890,\n            \"login\" : \"Delia@yy.com\"\n            \"company\": \"Company Y\",\n            \"email\": \"bernie@yy.com\",\n            \"mobile\": \"001445888\",\n            \"phone\": \"001445888\",\n            \"title\": \"Ms.\",\n            \"gender\": \"F\"\n        }\n    ]\n}\n\n

A user / usergroup import is something which needs to be executed frequently since changes in the ERP / CRM should be made available in Propeller, new customers need to get access to the webshop and in certain situations access to the webshop needs to be revoked. Using the bulk endpoints, the payload only needs to be defined once without any logic.

Order export

Order searching is typically used in combination with exporting orders to ERP/financial/other external systems. Within the Propeller order workflow there will be the need to export orders at a certain point. Most of the times the need to export an order is when the order transistions to a certain status (e.g. CONFRIMED). Via the order search api it is possible to retrieve a list of orders which are in status CONFIRMED and have not been exported yet (using the fields below)

{\n    \"status\": \"CONFIRMED\",\n    \"exported\": false    \n}\n\n

Once the orders have been exported it is good practice to update the order and mark it as \"exported\" field using the order update api. Searching for orders with the above payload will then only result in an list of orders without the previously exported orders.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"HTTP methods","slug":"http-methods"},{"content":"Authentication","slug":"authentication"},{"content":"Lookup keys","slug":"lookup-keys"},{"content":"Expanding resources","slug":"expanding-resources"},{"content":"Pagination","slug":"pagination"},{"content":"Errors","slug":"errors"},{"content":"Localized String","slug":"localized-string"},{"content":"Bulk endpoints","slug":"bulk-endpoints"},{"content":"Directives","slug":"directives"},{"content":"Usecases","slug":"usecases"}],"owner":"17120068","collectionId":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","publishedId":"UVkpPvzT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-05-02T13:37:29.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get access token","id":"6875f451-f0ef-4bbf-9789-c774e7837375","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{key}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://api.helice.cloud/oauth2/token","description":"

Use this endpoint to retrieve an access token for accessing the REST APIs.

\n","urlObject":{"host":["https://api.helice.cloud/oauth2/token"],"query":[],"variable":[]}},"response":[{"id":"e36b2ab4-b5f8-47a0-a693-2c8922becc22","name":"Get access token - 200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://api.helice.cloud/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"x-request-id","value":"bf951b46-1e6d-4f2a-b5e6-b87281df731b"},{"key":"content-length","value":"589"},{"key":"date","value":"Thu, 10 Mar 2022 00:55:16 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"refresh_token_expires_in\": \"0\",\n \"api_product_list\": \"[Propeller REST APIs]\",\n \"api_product_list_json\": [\n \"Propeller REST APIs\"\n ],\n \"organization_name\": \"propeller-platform-prod\",\n \"developer.email\": \"developer@propel.us\",\n \"token_type\": \"BearerToken\",\n \"issued_at\": \"1646873717224\",\n \"client_id\": \"veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT\",\n \"access_token\": \"ARAo4GjuI1bGSyenSKx5oYfFGuFQ\",\n \"application_name\": \"a1ca275a-2abb-4bd3-82b0-3ae699d75e40\",\n \"scope\": \"\",\n \"expires_in\": \"1899\",\n \"refresh_count\": \"0\",\n \"status\": \"approved\"\n}"},{"id":"647b02ae-6938-4957-9784-edd1db0611ab","name":"Get access token - 401 (wrong client id / client secret)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://api.helice.cloud/oauth2/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"x-request-id","value":"c75881bb-a9b1-4258-922d-a8053fa1c661"},{"key":"content-length","value":"64"},{"key":"date","value":"Thu, 10 Mar 2022 00:58:18 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"invalid_client\",\n \"Error\": \"ClientId is Invalid\"\n}"},{"id":"4d788df9-d6bb-47f7-ad34-8c1ca918e4e9","name":"Get access token - 400 (invalid body value)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://api.helice.cloud/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"x-request-id","value":"4c0191c8-50f7-43c5-952d-a340bcef7208"},{"key":"content-length","value":"90"},{"key":"date","value":"Thu, 10 Mar 2022 00:59:09 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"invalid_request\",\n \"Error\": \"Unsupported grant type : client_credentials1\"\n}"}],"_postman_id":"6875f451-f0ef-4bbf-9789-c774e7837375"}],"id":"02838467-b2ce-4777-87dd-e27f183deffe","description":"

As already described in Authentication, each request needs a valid access_token which once retrieved is valid for 30 minutes. Use Get access token request to retrieve a valid access_token.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{key}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ce0dd268-0058-4571-82de-d2ad211cf6d4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"28aac538-d42d-4177-a860-b51956209e7e","type":"text/javascript","exec":[""]}}],"_postman_id":"02838467-b2ce-4777-87dd-e27f183deffe"},{"name":"Categories","item":[{"name":"Create Category","id":"cf877ed2-6aa1-4b25-826b-216317b20a6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 1320\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"sourceId\": \"020000\",\r\n \"source\": \"RESTAPI\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/categories/","description":"

Use this endpoint to create a single category. If a category is successfully created, the response will include the category id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
names	yes
descriptions	no
shortDescriptions	no
language	yes
parent	yes
sourceId	no
source	only when `sourceId` is provided

Use this endpoint to retrieve category details by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"RESTAPI"},{"disabled":true,"description":{"content":"

Optional. Default language of the category

\n","type":"text/plain"},"key":"language","value":"NL"},{"description":{"content":"

Use translation when retrieveing translated fields in all lanugages. By default, only the default language of the category will be provided. What is resource expanding?

\n","type":"text/plain"},"key":"expands","value":"translation"}],"variable":[{"description":{"content":"

Lookup key. Read more about category lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"1787","key":"lookupValue"}]}},"response":[{"id":"017f0cb7-cc71-4c49-a3b8-c44961c3aa17","name":"Get Category by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue?expands=translation","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the category","disabled":true},{"key":"expands","value":"translation","description":"Use `translation` when retrieveing translated fields in all lanugages. By default, only the default language of the category will be provided. [What is resource expanding?](#expanding-resources)"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"1787","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"296"},{"key":"date","value":"Mon, 21 Mar 2022 16:35:24 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"b2659cec-8785-495f-a30e-7e94d7558c65"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Bike\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Bike\"\n }\n ],\n \"id\": 1787,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Bike\"\n }\n ]\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"effaa2a0-8b83-4045-b909-46e527aacdbf","name":"Get Category by sourceId - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue?source=RESTAPI&language=NL&expands=translation ","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`"},{"key":"language","value":"NL","description":"Optional. Default language of the category"},{"key":"expands","value":"translation ","description":"Optional. Use `translation` when retrieveing translated fields in all lanugages. By default, only the default language of the category will be provided. [What is resource expanding?](#expanding-resources)"}],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"1771","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"173"},{"key":"date","value":"Mon, 21 Mar 2022 09:12:17 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c768dcde-4761-49b4-b233-2c69213793a3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/30006\",\n \"messages\": [\n \"Category with sourceId [1771] not found\"\n ],\n \"status\": 404,\n \"code\": 30006,\n \"type\": \"CategoryNotFound\"\n }\n}"}],"_postman_id":"8554af73-fa11-4c52-b4d7-7d6ff16f55cd"},{"name":"Update Category by lookup key","id":"da2f7c29-8d46-4cca-82f2-a3f1188b766b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 1320\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"sourceId\": \"020000\",\r\n \"source\": \"RESTAPI\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue","description":"

Use this endpoint to update category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"RESTAPI"},{"disabled":true,"description":{"content":"

Optional. Default language of the category

\n","type":"text/plain"},"key":"language","value":"NL"}],"variable":[{"description":{"content":"

Lookup key. Read more about category lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"1771","key":"lookupValue"}]}},"response":[{"id":"ee958b6c-3254-475d-a5b3-66bd60a0dd1e","name":"Update Category by id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 1320\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the category","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"1771","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"350"},{"key":"date","value":"Wed, 30 Mar 2022 12:49:05 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"27bfbfa7-8497-4486-92c3-8c0aa9ebb958"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"parent\": {\n \"id\": 1320\n },\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Bike\"\n }\n ],\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Bike\"\n }\n ],\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Bike\"\n }\n ],\n \"sourceId\": \"020000\",\n \"source\": \"RESTAPI\",\n \"id\": 1771\n },\n \"messages\": [\n \"Category updated\"\n ],\n \"total\": 1\n}"},{"id":"c76054a8-adf7-499f-909c-1e2f82fe0e04","name":"Update Category by source id - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 1320\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"sourceId\": \"020000\",\r\n \"source\": \"RESTAPI\" \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue?source=RESTAPI","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`"},{"key":"language","value":"NL","description":"Optional. Default language of the category","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"17712","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"174"},{"key":"date","value":"Wed, 30 Mar 2022 12:50:24 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"203f32e5-5475-4605-b89d-cacd6f366d32"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/30006\",\n \"messages\": [\n \"Category with sourceId [17712] not found\"\n ],\n \"status\": 404,\n \"code\": 30006,\n \"type\": \"CategoryNotFound\"\n }\n}"}],"_postman_id":"da2f7c29-8d46-4cca-82f2-a3f1188b766b"},{"name":"Delete Category by lookup key","id":"23797f69-f5b1-4d69-aad6-f1928ba0da72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue","description":"

Use this endpoint to delete category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"RESTAPI"},{"disabled":true,"description":{"content":"

Optional. Default language of the category

\n","type":"text/plain"},"key":"language","value":"NL"}],"variable":[{"description":{"content":"

Lookup key. Read more about category lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"1772","key":"lookupValue"}]}},"response":[{"id":"b055f2ac-a45c-44da-b7be-456d7cfd16c7","name":"Delete Category by id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the category","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"1772","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"45"},{"key":"date","value":"Mon, 21 Mar 2022 09:50:11 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"17694f03-bade-42cd-b6eb-6d3a8a26e059"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Category deleted\"\n ]\n}"},{"id":"7ccc6196-ea57-4ae5-9fee-deee91ae69ae","name":"Delete Category by id - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the category","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"2947","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"173"},{"key":"date","value":"Mon, 21 Mar 2022 09:51:52 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"ba822dc2-7469-4fe8-947c-df32cc262366"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/30006\",\n \"messages\": [\n \"Category with sourceId [2947] not found\"\n ],\n \"status\": 404,\n \"code\": 30006,\n \"type\": \"CategoryNotFound\"\n }\n}"}],"_postman_id":"23797f69-f5b1-4d69-aad6-f1928ba0da72"},{"name":"Delete Category translation by lookup key","id":"0a604053-740f-425e-989c-d09e60b1e0f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue/translation/:translationLanguage","description":"

Use this endpoint to delete category translation by lookup key and the language for which the translation needs to be deleted. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"RESTAPI"},{"disabled":true,"description":{"content":"

Optional. Default language of the category

\n","type":"text/plain"},"key":"language","value":"NL"}],"variable":[{"description":{"content":"

Lookup key. Read more about category lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"1773","key":"lookupValue"},{"description":{"content":"

The language to delete. Cannot be the default language of the category

\n","type":"text/plain"},"type":"any","value":"FR","key":"translationLanguage"}]}},"response":[{"id":"c45f3306-123c-4f69-952d-36d3b82b7ab0","name":"Delete Category translation by id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue/translation/:translationLanguage","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue","translation",":translationLanguage"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the category","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"1773","description":"The value of the key (id or sourceId)"},{"key":"translationLanguage","value":"EN","description":"The language to delete. Cannot be the default language of the category"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"48"},{"key":"date","value":"Mon, 21 Mar 2022 09:26:06 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"339c22fa-5963-4449-ba88-b36251b74bd7"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Translation deleted\"\n ]\n}"},{"id":"fed75f91-b1ea-4b4f-81a3-7219fff2a976","name":"Delete Category translation by id - 404 (Category not found)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue/translation/:translationLanguage","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue","translation",":translationLanguage"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the category","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"1773","description":"The value of the key (id or sourceId)"},{"key":"translationLanguage","value":"FR","description":"The language to delete. Cannot be the default language of the category"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"167"},{"key":"date","value":"Mon, 21 Mar 2022 09:26:30 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"010fd880-d104-4542-a130-5d4b94567fbd"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/30006\",\n \"messages\": [\n \"Category with id [2947] not found\"\n ],\n \"status\": 404,\n \"code\": 30006,\n \"type\": \"CategoryNotFound\"\n }\n}"},{"id":"cbcc3a28-c3c6-4f1b-b2ff-a70d952b3105","name":"Delete Category translation by id - 404 (Translation not found)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/categories/:lookupKey/:lookupValue/translation/:translationLanguage","host":["https://api.helice.cloud/api/g/v1"],"path":["categories",":lookupKey",":lookupValue","translation",":translationLanguage"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the category","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"1773","description":"The value of the key (id or sourceId)"},{"key":"translationLanguage","value":"FR","description":"The language to delete. Cannot be the default language of the category"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"191"},{"key":"date","value":"Mon, 21 Mar 2022 09:27:22 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"0b6c651a-8a34-4e95-894e-b9acf9da929c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10018\",\n \"messages\": [\n \"[FR] translation for category with id [1773] not found\"\n ],\n \"status\": 404,\n \"code\": 10018,\n \"type\": \"TranslationNotFound\"\n }\n}"}],"_postman_id":"0a604053-740f-425e-989c-d09e60b1e0f3"},{"name":"Bulk Categories by sourceId","id":"49dee3e7-7cdd-4ab1-afc8-d752e8fdfdc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"categories\": [\r\n {\r\n \"sourceId\": \"010000\",\r\n \"source\": \"RESTAPI\",\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"shortDescription\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fiets\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Bike\"\r\n }\r\n ],\r\n \"parent\": {\r\n \"sourceId\": \"000000\",\r\n \"source\": \"RESTAPI\",\r\n \"language\": \"NL\"\r\n },\r\n \"attributes\": [ \r\n {\r\n \"name\": \"WEIGHT\" ,\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"value\": 15,\r\n },\r\n {\r\n \"name\": \"MATERIAAL_FRAME\" ,\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [ \r\n {\"language\": \"NL\", \"value\": \"Leer\"},\r\n {\"language\": \"EN\", \"value\": \"Leather\"}\r\n ]\r\n },\r\n {\r\n \"name\": \"HEIGHT\" ,\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\"language\": \"NL\", \"value\": \"\"},\r\n {\"language\": \"EN\", \"value\": \"\"}\r\n ],\r\n },\r\n {\r\n \"name\": \"COLOR\" ,\r\n \"class\": \"product\",\r\n \"type\": \"enum\"\r\n }\r\n ]\r\n },\r\n {\r\n \"sourceId\": \"020000\",\r\n \"source\": \"RESTAPI\",\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Accessoires\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Accessories\"\r\n }\r\n ],\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Accessoires\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Accessories\"\r\n }\r\n ],\r\n \"shortDescription\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Accessoires\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Accessories\"\r\n }\r\n ],\r\n \"parent\": {\r\n \"sourceId\": \"000000\",\r\n \"source\": \"RESTAPI\",\r\n \"language\": \"NL\"\r\n }\r\n },\r\n {\r\n \"sourceId\": \"020100\",\r\n \"source\": \"RESTAPI\",\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"GPS\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"GPS\"\r\n }\r\n ],\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"GPS\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"GPS\"\r\n }\r\n ],\r\n \"shortDescription\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"GPS\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"GPS\"\r\n }\r\n ],\r\n \"parent\": {\r\n \"sourceId\": \"020000\",\r\n \"source\": \"RESTAPI\",\r\n \"language\": \"NL\"\r\n }\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n },\r\n {\r\n \"operation\": \"skipMoveOnUpdate\",\r\n \"fields\": []\r\n },\r\n {\r\n \"operation\": \"mergeTranslationsOnUpdate\",\r\n \"fields\": []\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/categories/bulk/sourceId","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk sourceId endpoint, the categories are identified by sourceId, source and language. If a category doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go here.

A single category's attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple categories, this endpoint should be used.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
categories (array of category objects)	yes
sourceId	yes
source	yes
language	yes
names	yes
descriptions	no
shortDescriptions	no
attributes Read more about attributes	no
parent	yes

For more details on attributes field, read this.

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing category that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing category in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a category that are not provided in the payload	empty array

What are directives?

The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk id endpoint, the categories are identified by Propeller category id. If a category with such id doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
categories (array of category objects)	yes
sourceId	yes
source	yes
language	yes
names	yes
descriptions	no
shortDescriptions	no
attributes Read more about attributes	no
parent	yes

For more details on attributes field, read this.

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing category that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing category in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a category that are not provided in the payload	empty array

What are directives?

Categories are used in order to organize your product catalogue within your e-commerce platform. They work as hierarchical levels of product classification. There are no limits to the number of levels of categories, though it is recommended not to use too many levels. One product can belong to only one category. The same applies to categories, a category can have only one parent category.

Category Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller category id, auto-generated
sourceId	string	External system unique id. `sourceId` should be combined with `source`

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
names	Category name	array[LocalizedString]
descriptions	Category description	array[LocalizedString]
shortDescriptions	Category short description	array[LocalizedString]
language	Category default language.	ISO 639-1
parent	Parent category.	JSON object that identifies the parent. `id` or `sourceId` in combination with `source`
sourceId	External system unique id	string
source	External system	string

Category Errors

This section describes error codes specific for the Category resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
30004	CategoryExists	400	Category already exists	Category with such lookup key already exists
30005	CategoryMultipleFound	400	Multuple categories found. Please provide additional filters	Multiple categories with such lookup key exist
30006	CategoryNotFound	404	Category does not exist	Category with such lookup key not found
30007	ParentCategoryNotFound	404	Parent category not found	Parent category with such lookup key not found. This error is typical when working with category sub-resources (e.g. attributes)

","_postman_id":"68d93fc5-cba9-434a-adfb-96b626d854b2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Products","item":[{"name":"Create Product","id":"decdaf50-ba19-427e-a533-105e9fa15302","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/","description":"

Use this endpoint to create a single product. If a product is successfully created, the response will include the productid.

Fields

Name	Required
names	no
language	yes
parent	no
sku	no (recommended)
unit	no Default is `1`
status	no Default is `A`
price	no Default is `0.00`
costPrice	no Default is `0.00`
suggestedPrice	no Default is `0.00`
priceDisplay	no Default is `default`
descriptions	no
shortName	no
shortDescriptions	no
taxCode	no Default is `H`
supplier	no (recommended)
supplierCode	no (recommended)
manufacturer	no
oemCode	no
eanCode	no
minimumQuantity	no Default is `1`
package	no
packageDescriptions	no
notes	no
sourceId	no
source	only when `sourceId` is provided

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}},"urlObject":{"path":["products",""],"host":["https://api.helice.cloud/api/g/v1"],"query":[],"variable":[]}},"response":[{"id":"a0e36f1e-fec3-4d94-b565-38680764a4d3","name":"Create Product - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 1771\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"2854"},{"key":"date","value":"Mon, 21 Mar 2022 09:14:19 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"d6169a2d-ed01-4abd-b306-4da9e44d56bb"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"language\": \"NL\",\n \"parent\": {\n \"id\": 1771\n },\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Edge 1030 Bike computer\"\n }\n ],\n \"sku\": \"NCABD70004\",\n \"status\": \"A\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\n }\n ],\n \"shortName\": \"Edge 1030 Fietscomputer\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\n }\n ],\n \"supplier\": \"TECHDATA\",\n \"supplierCode\": \"NCABD70004\",\n \"oemCode\": \"NCABD70004\",\n \"eanCode\": \"0753759256289\",\n \"taxCode\": \"H\",\n \"price\": 599.95,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"manufacturer\": \"Garmin\",\n \"costPrice\": 400.95,\n \"suggestedPrice\": 580.00,\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Pieces\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Edge 1030 Bike computer\"\n }\n ],\n \"source\": \"TECHDATA\",\n \"sourceId\": \"NCABD70004\",\n \"id\": 40360\n },\n \"messages\": [\n \"Product created\"\n ],\n \"total\": 1\n}"},{"id":"d871b55a-b509-4d67-9b71-d5b50c868b8a","name":"Create Product - 400 (existing sourceId)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"180"},{"key":"date","value":"Mon, 21 Mar 2022 09:15:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e7ee4951-7e62-4923-bc92-04030f60ec74"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80004\",\n \"messages\": [\n \"Product with sourceId [NCABD70004] already exists\"\n ],\n \"status\": 400,\n \"code\": 80004,\n \"type\": \"ProductExists\"\n }\n}"}],"_postman_id":"decdaf50-ba19-427e-a533-105e9fa15302"},{"name":"Get Product by lookup key","event":[{"listen":"test","script":{"id":"3a6f68c5-873c-43d4-8fc3-7cde5787d80f","exec":["pm.test(\"Response time is less than 200ms\", () => {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r","let jsonData = pm.response.json();\r","pm.test(\"Response body is valid\", function () {\r"," pm.expect(jsonData.data.code).to.eql(\"AA12003\");\r"," pm.expect(jsonData.data.name).to.eql(\"Water - Spring Water, 355 Ml - updated\");\r","});"],"type":"text/javascript"}}],"id":"0bea941c-596f-41fd-84a8-608916fd6283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue?expands=translation","description":"

Use this endpoint to retrieve product details by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"TECHDATA"},{"disabled":true,"description":{"content":"

Optional. Default language of the product

\n","type":"text/plain"},"key":"language","value":"NL"},{"description":{"content":"

Optional. Use translation when retrieving translated fields in all lanugages. By default, only the default language of the product will be provided. What is resource expanding?

\n","type":"text/plain"},"key":"expands","value":"translation"},{"disabled":true,"description":{"content":"

Optional. Used in combination with lookup key supplierCode

\n","type":"text/plain"},"key":"supplier","value":"TECHDATA"}],"variable":[{"description":{"content":"

Lookup key. Read more about product lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id, sourceId, sku or supplierCode)

\n","type":"text/plain"},"type":"any","value":"40360","key":"lookupValue"}]}},"response":[{"id":"29a80b23-51fe-4b79-99ca-93e4b83ea2e6","name":"Get Product by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue?expands=translation","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","type":"text","disabled":true},{"key":"expands","value":"translation","description":"Optional. Use `translation` when retrieveing translated fields in all lanugages. By default, only the default language of the product will be provided. [What is resource expanding?](#expanding-resources)"},{"key":"supplier","value":"TECHDATA","description":"Optional. Used in combination with lookup key `supplierCode`","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"40360","description":"The value of the key (id, sourceId, sku or supplierCode)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"2771"},{"key":"date","value":"Mon, 21 Mar 2022 09:16:17 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"211845eb-9c56-4683-8ee7-e8af35583625"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"eanCode\": \"0753759256289\",\n \"price\": 599.95,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Edge 1030 Bike computer\"\n }\n ],\n \"oemCode\": \"NCABD70004\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Edge 1030 Bike computer\"\n }\n ],\n \"shortName\": \"Edge 1030 Fietscomputer\",\n \"sku\": \"NCABD70004\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 0.21,\n \"supplierCode\": \"NCABD70004\",\n \"status\": \"A\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Pieces\"\n }\n ],\n \"id\": 40360,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"manufacturer\": \"Garmin\",\n \"costPrice\": 400.95,\n \"suggestedPrice\": 580.00,\n \"package\": \"STK\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\n }\n ],\n \"supplier\": \"TECHDATA\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"b2f11f8f-5f8a-4915-9f3c-aa9752a9f2d4","name":"Get Product by sourceId - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue?expands=translation","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","type":"text","disabled":true},{"key":"expands","value":"translation","description":"Optional. Use `translation` when retrieveing translated fields in all lanugages. By default, only the default language of the category will be provided. [What is resource expanding?](#expanding-resources)"},{"key":"supplier","value":"TECHDATA","description":"Optional. Used in combination with lookup key `supplierCode`","type":"text","disabled":true}],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"40360","description":"The value of the key (id, sourceId, sku or supplierCode)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"172"},{"key":"date","value":"Mon, 21 Mar 2022 09:18:07 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"3b73cffc-5153-4eef-ba0d-33867d59d3fa"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with sourceId [40360] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"}],"_postman_id":"0bea941c-596f-41fd-84a8-608916fd6283"},{"name":"Update Product by lookup key","event":[{"listen":"test","script":{"id":"2372d64a-a615-4bae-b782-d9a552e3767d","exec":["pm.test(\"Response time is less than 200ms\", () => {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r","let jsonData = pm.response.json();\r","pm.test(\"Total updated products to equal 1\", function () {\r"," pm.expect(jsonData.total).to.eql(1);\r","});"],"type":"text/javascript"}}],"id":"37f61668-bfb7-4979-87e8-a41bdd0828a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue","description":"

Use this endpoint to update product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"TECHDATA"},{"disabled":true,"description":{"content":"

Optional. Default language of the product

\n","type":"text/plain"},"key":"language","value":"NL"}],"variable":[{"description":{"content":"

Lookup key. Read more about product lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id, sourceId, sku or supplierCode)

\n","type":"text/plain"},"type":"any","value":"48118","key":"lookupValue"}]}},"response":[{"id":"dd4f8fb7-a1fc-4d78-9eba-c9b8445ddd5f","name":"Update Product by id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"40360","description":"The value of the key (id, sourceId, sku or supplierCode)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"2842"},{"key":"date","value":"Mon, 21 Mar 2022 16:44:15 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"5706c871-1334-4255-8b48-b3c7bedf4b11"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"parent\": {\n \"id\": 1202\n },\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Edge 1030 Bike computer\"\n }\n ],\n \"sku\": \"NCABD70004\",\n \"status\": \"A\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\n }\n ],\n \"shortName\": \"Edge 1030 Fietscomputer\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\n }\n ],\n \"supplier\": \"TECHDATA\",\n \"supplierCode\": \"NCABD70004\",\n \"oemCode\": \"NCABD70004\",\n \"eanCode\": \"0753759256289\",\n \"taxCode\": \"H\",\n \"price\": 599.95,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"manufacturer\": \"Garmin\",\n \"costPrice\": 400.95,\n \"suggestedPrice\": 580.00,\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Pieces\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Edge 1030 Bike computer\"\n }\n ],\n \"source\": \"TECHDATA\",\n \"sourceId\": \"NCABD70004\",\n \"id\": 40360\n },\n \"messages\": [\n \"Product updated\"\n ],\n \"total\": 1\n}"},{"id":"e021c3d4-5bb0-4b1c-bdb2-f2c2e6164a7c","name":"Update Product by id - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"name\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"48118","description":"The value of the key (id, sourceId, sku or supplierCode)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Mon, 21 Mar 2022 16:45:30 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"f0b68a32-00b9-42ac-9c7e-bccbf48fef35"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"1a3d9467-67e5-4410-940f-f6d81e0f9917","name":"Update Product by id - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"481189","description":"The value of the key (id, sourceId, sku or supplierCode)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"167"},{"key":"date","value":"Mon, 21 Mar 2022 16:46:57 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"fdad0066-9b0d-4ea6-b84b-2e681cbfe8e9"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [481189] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"}],"_postman_id":"37f61668-bfb7-4979-87e8-a41bdd0828a8"},{"name":"Delete Product by lookup key","event":[{"listen":"test","script":{"id":"3a8fbefe-f4db-46b3-a179-f48aee5682c2","exec":["pm.test(\"Response time is less than 300ms\", () => {\r"," pm.expect(pm.response.responseTime).to.be.below(300);\r","});"],"type":"text/javascript"}}],"id":"b04624a1-824e-4592-9711-a66cd3817389","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue","description":"

Use this endpoint to delete product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"TECHDATA"},{"disabled":true,"description":{"content":"

Optional. Default language of the product

\n","type":"text/plain"},"key":"language","value":"NL"}],"variable":[{"description":{"content":"

Lookup key. Read more about product lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id, sourceId, sku or supplierCode)

\n","type":"text/plain"},"type":"any","value":"40360","key":"lookupValue"}]}},"response":[{"id":"d69f5092-75a3-4002-9ecb-f5eb7ce7d419","name":"Delete Product by id - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"48118","description":"The value of the key (id, sourceId, sku or supplierCode)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Mon, 21 Mar 2022 17:22:58 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"b9e159d2-8408-43a6-8447-640330bf2c84"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [48118] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"},{"id":"188b0712-ab86-4f6c-9167-1afe06792573","name":"Delete Product by id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"40360","description":"The value of the key (id, sourceId, sku or supplierCode)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Mon, 21 Mar 2022 17:24:29 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"27b7563c-4551-40a5-ba90-bf94e493dd33"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Product deleted\"\n ]\n}"}],"_postman_id":"b04624a1-824e-4592-9711-a66cd3817389"},{"name":"Delete Product translation by lookup key","event":[{"listen":"test","script":{"id":"3a8fbefe-f4db-46b3-a179-f48aee5682c2","exec":["pm.test(\"Response time is less than 300ms\", () => {\r"," pm.expect(pm.response.responseTime).to.be.below(300);\r","});"],"type":"text/javascript"}}],"id":"cabdbb86-aa67-4340-8dfc-5ff2c4c92888","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue/translation/:translationLanguage","description":"

Use this endpoint to delete product translation by lookup key and the language for which the translation needs to be deleted. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. source and language for lookup key source).

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"TECHDATA"},{"disabled":true,"description":{"content":"

Optional. Default language of the product

\n","type":"text/plain"},"key":"language","value":"NL"}],"variable":[{"description":{"content":"

Lookup key. Read more about product lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id, sourceId, sku or supplierCode)

\n","type":"text/plain"},"type":"any","value":"48118","key":"lookupValue"},{"description":{"content":"

The language to delete. Cannot be the default language of the category

\n","type":"text/plain"},"type":"any","value":"FR","key":"translationLanguage"}]}},"response":[{"id":"985b2fc7-3bc5-4a8f-9154-06ec1ead1131","name":"Delete Product translation by id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue/translation/:translationLanguage","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue","translation",":translationLanguage"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"40360","description":"The value of the key (id, sourceId, sku or supplierCode)"},{"key":"translationLanguage","value":"EN","description":"The language to delete. Cannot be the default language of the category"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"48"},{"key":"date","value":"Mon, 21 Mar 2022 17:14:07 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"99ac5897-caa2-4aef-bec2-b1e62303a95e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Translation deleted\"\n ]\n}"},{"id":"4bd0bd39-e4bd-4e63-a5eb-e96ee14da8ee","name":"Delete Product translation by id - 404 (Product not found)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue/translation/:translationLanguage","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue","translation",":translationLanguage"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"48118","description":"The value of the key (id, sourceId, sku or supplierCode)"},{"key":"translationLanguage","value":"FR","description":"The language to delete. Cannot be the default language of the category"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Mon, 21 Mar 2022 17:06:47 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"91f6ad1b-b3dd-4ce6-8d73-f9a1abb219a5"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [48118] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"},{"id":"6598bbf5-6b58-4344-b270-d07fd80b37b2","name":"Delete Product translation by id - 404 (Translation not found)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupKey/:lookupValue/translation/:translationLanguage","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupKey",":lookupValue","translation",":translationLanguage"],"query":[{"key":"source","value":"TECHDATA","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true},{"key":"language","value":"NL","description":"Optional. Default language of the product","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"lookupValue","value":"40360","description":"The value of the key (id, sourceId, sku or supplierCode)"},{"key":"translationLanguage","value":"FR","description":"The language to delete. Cannot be the default language of the category"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"191"},{"key":"date","value":"Mon, 21 Mar 2022 17:13:26 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"bb654f7b-5ab0-42ae-91aa-04a4aacd98fc"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10018\",\n \"messages\": [\n \"[FR] translation for product with id [40360] not found\"\n ],\n \"status\": 404,\n \"code\": 10018,\n \"type\": \"TranslationNotFound\"\n }\n}"}],"_postman_id":"cabdbb86-aa67-4340-8dfc-5ff2c4c92888"},{"name":"Bulk Product by source id","id":"a78a829a-3bd3-4a19-94c8-0b0d2aa52a43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": \"020100\",\r\n \"source\": \"RESTAPI\"\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70005\",\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": \"020100\",\r\n \"source\": \"RESTAPI\"\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70005\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1050 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70005\",\r\n \"oemCode\": \"NCABD70005\",\r\n \"eanCode\": \"0753759256211\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"name\",\r\n \"description\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/bulk/sourceId","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk sourceId endpoint, the products are identified by sourceId, source and language. If a product doesn't already exist, it will be created. If it does exist, the product found will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go here.

A single product's attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple products, this endpoint should be used.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
products (array of product objects)	yes
sourceId	yes
source	yes
language	yes
names	no
sku	no (recommended)
unit	no Default is `1`
status	no Default is `A`
price	no Default is `0.00`
priceDisplay	no Default is `default`
descriptions	no
shortDescriptions	no
taxCode	no Default is `H`
supplier	no (recommended)
supplierCode	no (recommended)
oemCode	no
eanCode	no
minimumQuantity	no Default is `1`
packageDescriptions	no
notes	no
attributes Read more about attributes	no
parent	no

For more details on attributes field, read this.

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing product that are not empty	array of field names e.g. names, descriptions, packageDescriptions etc.
skipMoveOnUpdate	On update, skip moving an existing product in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a product that are not provided in the payload	empty array

What are directives?

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}},"urlObject":{"path":["products","bulk","sourceId"],"host":["https://api.helice.cloud/api/g/v1"],"query":[],"variable":[]}},"response":[{"id":"1bae1475-d4ec-449c-b51a-d2794a5a0afb","name":"Bulk Product by source id - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": \"020100\",\r\n \"source\": \"RESTAPI\"\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70005\",\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": \"020100\",\r\n \"source\": \"RESTAPI\"\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70005\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1050 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70005\",\r\n \"oemCode\": \"NCABD70005\",\r\n \"eanCode\": \"0753759256211\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/bulk/sourceId"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"221"},{"key":"date","value":"Mon, 21 Mar 2022 17:26:48 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"db53b21e-a47d-45d8-a561-5bc661d5d06b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": \"NCABD70004\",\n \"id\": 40362,\n \"action\": \"create\",\n \"lookupKey\": \"sourceId\"\n },\n {\n \"success\": true,\n \"key\": \"NCABD70005\",\n \"id\": 40364,\n \"action\": \"create\",\n \"lookupKey\": \"sourceId\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"2b9c368e-e556-4bdd-96e3-8d63929154ab","name":"Bulk Product by source id - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": \"020100\",\r\n \"source\": \"RESTAPI\"\r\n },\r\n \"name\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"brand\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\"\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": \"020100\",\r\n \"source\": \"RESTAPI\"\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70005\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1050 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70005\",\r\n \"oemCode\": \"NCABD70005\",\r\n \"eanCode\": \"0753759256211\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"brand\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70005\"\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/bulk/sourceId"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"242"},{"key":"date","value":"Mon, 21 Mar 2022 17:28:04 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"59b15fa3-b7ef-4397-9991-b861daf5962a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/products/0: required key [names] not found\",\n \"#/products/0: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"a78a829a-3bd3-4a19-94c8-0b0d2aa52a43"},{"name":"Bulk Product by id","id":"632ba9fd-858c-47b3-9692-aa7d9664bd69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"id\": 40366,\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"id\": 40368,\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70005\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1050 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70005\",\r\n \"oemCode\": \"NCABD70005\",\r\n \"eanCode\": \"0753759256211\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"name\",\r\n \"description\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/bulk/id","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk id endpoint, the products are identified by Propeller product id. If a product with such id doesn't already exist, it will be created. If it does exist, the product will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
products (array of product objects)	yes
sourceId	yes
source	yes
language	yes
names	no
sku	no (recommended)
unit	no Default is `1`
status	no Default is `A`
price	no Default is `0.00`
priceDisplay	no Default is `default`
descriptions	no
shortDescriptions	no
taxCode	no Default is `H`
supplier	no (recommended)
supplierCode	no (recommended)
oemCode	no
eanCode	no
minimumQuantity	no Default is `1`
packageDescriptions	no
notes	no
attributes Read more about attributes	no
parent	no

For more details on attributes field, read this.

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing product that are not empty	array of field names e.g. names, descriptions, packageDescriptions etc.
skipMoveOnUpdate	On update, skip moving an existing product in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a product that are not provided in the payload	empty array

What are directives?

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}},"urlObject":{"path":["products","bulk","id"],"host":["https://api.helice.cloud/api/g/v1"],"query":[],"variable":[]}},"response":[{"id":"9b5dad15-01e3-473c-bfd6-9868188d2973","name":"Bulk Product by id - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"id\": 0,\r\n \"parent\": {\r\n \"id\": 1785\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"id\": 48118,\r\n \"parent\": {\r\n \"id\": 1785\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70005\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1050 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70005\",\r\n \"oemCode\": \"NCABD70005\",\r\n \"eanCode\": \"0753759256211\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"brand\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/bulk/id"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"191"},{"key":"date","value":"Mon, 21 Mar 2022 17:31:55 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"a3b9ed62-8e3b-4461-a35c-10b6d93dafce"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": 0,\n \"id\": 40366,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 48118,\n \"id\": 40368,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"7f62594a-f675-4755-81ff-33c8a99ea011","name":"Bulk Product by id - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"id\": 40366,\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"name\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"brand\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLOR_LABEL_1\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Fietscomputer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PROPELLOR_LABEL_2\",\r\n \"type\": \"text\",\r\n \"class\": \"product\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Garmin\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"id\": 40368,\r\n \"parent\": {\r\n \"id\": 1202\r\n },\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70005\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1050 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70005\",\r\n \"oemCode\": \"NCABD70005\",\r\n \"eanCode\": \"0753759256211\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"brand\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1050 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1050 Bike computer\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/bulk/id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"242"},{"key":"date","value":"Mon, 21 Mar 2022 17:34:08 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"753ccea0-3d08-4a73-af3c-3333c94ff61c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/products/0: required key [names] not found\",\n \"#/products/0: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"632ba9fd-858c-47b3-9692-aa7d9664bd69"},{"name":"Search Products","id":"c6192a39-dd01-43aa-98d9-724ec335c933","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"term\": \"fietscomputer\",\r\n \"categoryId\": 1200,\r\n \"code\": \"NCABD70005\",\r\n \"oemCode\": \"NCABD70005\",\r\n \"eanCode\": \"0753759256211\",\r\n \"manufacturer\": \"Garmin\",\r\n \"supplierCodes\": [\r\n \"NCABD70005\"\r\n ],\r\n \"textFilters\": [\r\n {\r\n \"searchId\": \"MATERIAL_FRAME\",\r\n \"value\": \"Leer\"\r\n }\r\n ],\r\n \"rangeFilters\": [\r\n {\r\n \"searchId\": \"WEIGHT\",\r\n \"from\": 65.2,\r\n \"to\": 120\r\n }\r\n ],\r\n \"priceFilters\": {\r\n \"from\": 150.23,\r\n \"to\": 500.25\r\n },\r\n \"dateCreated\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2022-12-12T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2022-12-12T00:00:00\"\r\n },\r\n \"orderBy\": \"product_price\",\r\n \"orderDirection\": \"ASC\",\r\n \"offset\": 10,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/search","description":"

\n
The product search endpoint is only available on the Propeller legacy version. The cloud version of Propeller does not support this API. Instead, use the GraphQL APIs to query products.
\n

Retrieves a list of products by using the search fields below. Results will be paginated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
term Search through any text indexed on a product, like name, descriptions, product codes, keywords, etc.	array[integer]
categoryId	integer
code	string
oemCode	string
eanCode	string
manufacturer	string
supplierCodes	array[string]
textFilters	array[TextFilter]
rangeFilers	array[RangeFilter]
priceFilters	PriceFilter
dateCreated	DateFilter
dateModified	date (yyyy-mm-ddThh:nn:ss)
orderBy	enum product_price= order by `price` product_name = order by `name` product_code = order by `sku`product_manufacturer = order by `brand` product_suppliercode = order by `supplierCode`product_oemcode = order by `oemCode` directory_order = order by `dateCreated` product_supplier = order by `supplier` container_name = order by category `name` best_sold = order by number of times sold
orderDirection	enum ASC = ascending DESC = descending
offset	integer
page	integer

Product text filter

A text filter is used to search through text product fields and product attributes of type text, list, enum or enumlist, in which case searchId is the name of the attribute. When searching product fields, searchId can be:

searchproduct_code: sku
searchproduct_name: name
searchproduct_suppliercode: supplierCode
searchcode_supplier: supplier
searchcode_manufacturer:brand
searchproduct_oemcode: oemCode
searchproduct_container_name: name of parent category

{\n    \"searchId\": \"MATERIAL_FRAME\",\n    \"value\": \"Leer\"\n}\n\n

Product range filter

A range filter is used to search through numeric product attributes i.e. attributes of type integer or decimal, in which case searchId is the name of the attribute.

{\n    \"searchId\": \"WEIGHT\",\n    \"from\": 65.2,\n    \"to\": 120\n}\n\n

\n\n

A price filter is a special price search object that can search through a range:

{\n    \"from\": 150.23,\n    \"to\": 500.25\n}\n\n

Product date filter

A date filter is a special date search object that can search through a range:

{\n    \"from\": \"2020-12-12T00:00:00\",\n    \"to\": \"2022-12-12T00:00:00\"\n}\n\n

Products are the sellable goods in an e-commerce shop on the Propeller platform. They are usually organized hierarchically in categories. The Product API can be used to consult, create, update or delete a Product.

Product Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller category id, auto-generated
sourceId	string	External system unique id. `sourceId` should be combined with `source`
sku	string	Product SKU/ code
code (deprecated)	string	Product code
supplierCode	string	Product code as known to the product supplier. `supplierCode` should be combined with `supplier`

What are lookup keys?

Fields

Name	Description	Type
names	Product name	array[LocalizedString]
language	Product default language	ISO 639-1
parent	Parent category	JSON object that identifies the parent. `id` or `sourceId` in combination with `source`
sku	Product SKU (code)	string
unit	The number of packages that need to be ordered when adding an item to the basket	integer
status	Product status	enum A=Available N=Not available T=Out of stock P=Phase out S=Presale R=Restricted
price	Sales price	decimal
costPrice	Cost price	decimal
suggestedPrice	Suggested/ advised price	decimal
discountPrice	Discount price	decimal
discountPriceFrom	Discount price from date	date
discountPriceTo	Discount price to date	date
priceDisplay	Type of price display	enum default = Only display price onrequest = Do not show price, show \"Price on request\" from = Show cheapest price fromfor = Show old (suggested) price vs. new price perpackage = price per type of package (e.g. Price from € 125.50 per box) peruom = Cheapest price per package unit (e.g. Price from € 125.50 per piece)
descriptions	Product description	array[LocalizedString]
shortName	Product short name	string
shortDescriptions	Product short descriptions	array[LocalizedString]
taxCode	Product tax code	enum H=High L=Low N=None
supplier	Product supplier	string
supplierCode	Product code as known to the product supplier	string
manufacturer	Manufacturer	string
oemCode	Product manufacturer code	string
eanCode	Product EAN code	string
minimumQuantity	Minimum orderable quantity	integer
package	Package (e.g. piece, sheet, etc.)	string
packageDescriptions	Description of package and package units inside a package (e.g. Box of 650 sheets of paper)	array[LocalizedString]
notes	Product notes/ remarks	array[LocalizedString]
sourceId	External system unique id	string
source	External system	string

Product Errors

This section describes error codes specific for the Product resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
80004	ProductExists	400	Product already exists	Category with such lookup key already exists
80005	ProductMultipleFound	400	Multuple products found. Please provide additional filters	Multiple products with such lookup key exist
80006	ProductNotFound	404	Product does not exist	Product with such lookup key not found
80007	ParentProductNotFound	404	Parent product not found	Parent product with such lookup key not found. This error is typical when working with product sub-resources (e.g. attributes)
80008	ProductNotAllowed	405	Product is not allowed	No permission for the product

","_postman_id":"7ea439b3-c642-4649-8738-6fb0e5ca123b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Users","item":[{"name":"Addresses","item":[{"name":"Create Address","id":"9e9707cc-b82a-4fbe-a51f-377229a5b908","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/","description":"

Use this endpoint to create an address for a user. If the address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	no
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14760","key":"lookupValue"}]}},"response":[{"id":"41e79e41-ba68-4c3a-a78e-b0ffc1f5c253","name":"Create Address - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"418"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c5d9386a-4819-45c5-850d-1128b3787284"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"delivery\",\n \"code\": \"11234\",\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"street\": \"Noordpad\",\n \"postalCode\": \"6822 DE\",\n \"city\": \"Arnhem\",\n \"icp\": \"N\",\n \"country\": \"NL\",\n \"region\": \"\",\n \"number\": \"34\",\n \"numberExtension\": \"A\",\n \"notes\": \"Address notes\",\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"company\": \"Propel\",\n \"url\": \"www.propel.us\",\n \"isDefault\": \"Y\",\n \"id\": 81908\n },\n \"messages\": [\n \"Address created\"\n ],\n \"total\": 1\n}"},{"id":"47ac68bf-59bd-4c56-85a9-a489b361bbd5","name":"Create Address - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"U\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"183"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:47 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"92281dd9-7086-4fa5-9d3b-84fd66d74ce6","name":"Create Address - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"147601","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Thu, 17 Mar 2022 01:14:19 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [147601] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"9e9707cc-b82a-4fbe-a51f-377229a5b908"},{"name":"Bulk Addresses","id":"7040ad61-35dd-4c23-86b0-cc915eedd420","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/bulk","description":"

Use this endpoint to create multiple user addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	yes
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"6ed7ca95-995d-471a-ab1b-724271ad812a","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14760","key":"lookupValue"}]}},"response":[{"id":"2bb7f50b-dc7b-43f2-a024-275160606b17","name":"Bulk Addresses - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"418"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c5d9386a-4819-45c5-850d-1128b3787284"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"delivery\",\n \"code\": \"11234\",\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"street\": \"Noordpad\",\n \"postalCode\": \"6822 DE\",\n \"city\": \"Arnhem\",\n \"icp\": \"N\",\n \"country\": \"NL\",\n \"region\": \"\",\n \"number\": \"34\",\n \"numberExtension\": \"A\",\n \"notes\": \"Address notes\",\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"company\": \"Propel\",\n \"url\": \"www.propel.us\",\n \"isDefault\": \"Y\",\n \"id\": 81908\n },\n \"messages\": [\n \"Address created\"\n ],\n \"total\": 1\n}"},{"id":"1aec0665-72b4-4dc3-bcaa-305c45fc49e7","name":"Bulk Addresses - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"U\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"183"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:47 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"75a87854-1d1e-4767-92a6-85514380b4e0","name":"Bulk Addresses - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"147601","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Thu, 17 Mar 2022 01:14:19 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [147601] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"7040ad61-35dd-4c23-86b0-cc915eedd420"},{"name":"Get User Addresses by type","id":"4718f436-9083-4596-be8d-9cc77504bf84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/?type=delivery","description":"

Use this endpoint to retrieve a list of all user addresses. Addresses can be filtered by type.

Optional. Only retrieve a certain type of address. Possible values:

delivery\ninvoice\nhome

\n","type":"text/plain"},"key":"type","value":"delivery"}],"variable":[{"description":{"content":"

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14760","key":"lookupValue"}]}},"response":[{"id":"ecf35f48-3bef-4224-a6c8-0e003ce2645d","name":"Get User Delivery Addresses by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Filter on address type:\n\ndelivery\n\ninvoice"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"464"},{"key":"date","value":"Mon, 21 Mar 2022 18:50:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"7ba7b832-624b-49ee-ba0d-993be90732a3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 81908,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"N\",\n \"email\": \"miles@propel.us\"\n }\n ],\n \"messages\": [],\n \"total\": 1\n}"},{"id":"b51d7e01-8b7a-423c-87c1-d8f401f3fc7e","name":"Get User Delivery Addresses by id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Filter on address type:\n\ndelivery\n\ninvoice"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"147601","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Mon, 21 Mar 2022 18:50:40 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"ac58aef4-a7f5-426b-a374-170218dffed2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [147601] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"4718f436-9083-4596-be8d-9cc77504bf84"},{"name":"Get Address by id","id":"cc1d6530-6b2d-4e7d-8d36-e43222fcc572","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to retrieve details for a user address. The address is identified by id.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"147601","key":"lookupValue"},{"description":{"content":"

id of the address

\n","type":"text/plain"},"type":"any","value":"81908","key":"addressId"}]}},"response":[{"id":"1df6db59-c761-478f-891e-93b25e3234f6","name":"Get Address by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81908","description":"id of the address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"462"},{"key":"date","value":"Mon, 21 Mar 2022 18:54:28 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"14bcc898-8faa-46c0-bfae-56ebd5c4464c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 81908,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"N\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"e542905c-2695-4720-8927-78f5e47ec318","name":"Get Address by id - 404 (address not found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"819081","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"195"},{"key":"date","value":"Mon, 21 Mar 2022 18:55:33 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"8db2c1e7-369e-44c2-8a09-bc6c4364e0a0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [819081] not found for [User] with id [14760]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"},{"id":"a549d466-3091-48ac-b311-13025c98b128","name":"Get Address by id - 404 (user not found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"147601","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81908","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"185"},{"key":"date","value":"Wed, 20 Apr 2022 20:55:27 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"ec3d49c0-0e66-43d0-b954-753d8bf0fb70"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [147601] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"cc1d6530-6b2d-4e7d-8d36-e43222fcc572"},{"name":"Update Address","id":"94434e41-c9dc-4f0c-864a-27088ce6cefd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to update a user address. The address is identified by id.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"147601","key":"lookupValue"},{"description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"81908","key":"addressId"}]}},"response":[{"id":"0171cc1f-cbe2-426c-99f2-a77748fda307","name":"Update Address by id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81908","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"103"},{"key":"date","value":"Mon, 21 Mar 2022 19:12:27 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"820885e1-1675-4bf5-a07b-f418962b891d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"firstName\": \"Miles\",\n \"lastName\": \"McCoy\",\n \"id\": 81908\n },\n \"messages\": [\n \"Address updated\"\n ],\n \"total\": 1\n}"},{"id":"b9fb7153-d40a-40ae-bc93-3d728cd8c48f","name":"Update Address by id - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"147601","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81908","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"185"},{"key":"date","value":"Wed, 20 Apr 2022 18:25:06 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"ca307bd2-10cd-4551-a516-3b9f702fe1a6"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [147601] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"},{"id":"5129ac68-4f0a-4d6c-bc9f-a51176878b91","name":"Update Address by id - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstNames\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"147601","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81908","description":"Address id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"190"},{"key":"date","value":"Wed, 20 Apr 2022 18:25:49 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"6c032004-3b98-412d-b4ae-bd732ffb4748"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [firstNames] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"94434e41-c9dc-4f0c-864a-27088ce6cefd"},{"name":"Delete Address","id":"110fa000-d978-4cd8-8744-73fb615b2ef2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to delete a user's address. The address is identified by id.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14760","key":"lookupValue"},{"description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"81908","key":"addressId"}]}},"response":[{"id":"47bd969b-3767-4ead-9a1a-59bf42dfa945","name":"Delete Address by id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81908","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Wed, 20 Apr 2022 19:23:22 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"130478fb-d22e-45a6-90ed-1980abc20734"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Address deleted\"\n ]\n}"},{"id":"6cee95fc-1b17-4ae6-8034-219644458cc7","name":"Delete Address by id - 404 (user not found)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"id":"043ad2b2-414b-47ee-821a-8c60301d823d","key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"id":"8dedec66-6f26-4f30-a03f-6ab6ff52445d","key":"lookupValue","value":"147601","description":"The value of the key (id or sourceId)"},{"id":"dc131e9b-7ce1-4c80-9bc9-ad98e81aeeca","key":"addressId","value":"81908","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"185"},{"key":"date","value":"Wed, 20 Apr 2022 19:21:54 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c1936ffe-6011-4400-937b-3cbe71fdf4d8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [147601] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"},{"id":"478141ed-1eb7-45ba-825a-f0e867493d50","name":"Delete Address by id - 404 (address not found)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"819089","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"195"},{"key":"date","value":"Wed, 20 Apr 2022 19:22:30 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"50bca6e1-d150-4256-97a3-aa52d77a14a2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [819089] not found for [User] with id [14760]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"110fa000-d978-4cd8-8744-73fb615b2ef2"}],"id":"c39838d8-bf58-4f42-806d-62b986032715","description":"

The User Addresses endpoints can be used to manage user addresses. A user can have multiple addresses of different type: delivery, invoice or home.

Fields

Name	Description	Type
type	Address type	enum delivery invoice home
code	Address code	string
firstName	First name	string
middleName	Middle name	string
lastName	Last name	string
gender	Gender	enum M=Male F=Female U=Undefined
street	Street	string
number	Number	string
numberExtension	Number extension	string
postalCode	Postal code	string
city	City	string
country	Country	string
region	Region	string
icp	Indicates whether tax should be calculated when goods are delivered at this address	enum Y = Yes N = No
phone	Phone number	string
mobile	Mobile number	string
email	A valid email address	string
company	Organization the address is located at (if any)	string
url	Website	string
isDefault	Is this address the default address for the user of the provided type?	enum Y = Yes N = No
notes	Helpful notes for locating the address, etc.	string

","_postman_id":"c39838d8-bf58-4f42-806d-62b986032715","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Pricing","item":[{"name":"Create User Pricing","id":"023a1cd3-5889-46f8-b325-28638a16ef42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 1036522,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to define pricing for an existing user. The user can be identified by it's lookup key. It is required to provide either categories or products or both in the payload.

Use cases

A common use case for this endpoint is when you want to give discounts only for a specific user.

If you want to give a discount of 20% of sales price on all products in a given category you can use the SP type pricing for a category. The user will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for a single user.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14718","key":"lookupValue"}]}},"response":[{"id":"825c1f37-e52b-4504-966d-2435287d49d6","name":"Create User Pricing - 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 1036522,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14718","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"287"},{"key":"date","value":"Wed, 20 Apr 2022 15:18:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"7f30de39-8de3-4357-9069-82d776161996"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": 1797,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 77138,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"error\": \"product with id [1036522] not found\",\n \"success\": false,\n \"key\": 1036522,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"completed\"\n ],\n \"total\": 3\n}"},{"id":"5bc8dc84-9db6-482b-ad71-194375eff291","name":"Create User Pricing - 404","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 50887,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 1036521,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 1036522,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14699","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"186"},{"key":"date","value":"Wed, 20 Apr 2022 13:53:29 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"71944e53-63f3-4944-83cd-e2852346da21"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [14699] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"023a1cd3-5889-46f8-b325-28638a16ef42"},{"name":"Delete User Pricing","id":"35efea70-922a-49a3-8ac8-f5cc97aa9949","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to delete pricing for an existing user. The user can be identified by it's lookup key.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14718","key":"lookupValue"}]}},"response":[{"id":"aac08f93-882d-4683-b007-e7f33165b4c4","name":"Delete User Pricing - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14718","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Wed, 20 Apr 2022 15:29:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"0081d0da-5b74-4ff7-9099-b350fceb20bd"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"},{"id":"a6765fa0-4093-44fe-a786-e304af6dbe48","name":"Delete User Pricing - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"17486","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"186"},{"key":"date","value":"Wed, 20 Apr 2022 15:26:58 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"0259b0cd-14f1-4e4c-862e-96f54d5210a6"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [14699] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"35efea70-922a-49a3-8ac8-f5cc97aa9949"}],"id":"d4d01b21-2ec4-4bf0-b110-95651b1de19c","description":"

The User Pricing endpoints can be used to manage pricing for users. Read more about pricing to learn more details.

\n","_postman_id":"d4d01b21-2ec4-4bf0-b110-95651b1de19c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Create User","id":"d0f97fdb-2a15-4ddd-b51d-43ea45adce97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"login\": \"miles@propel.us\",\r\n \"primaryLanguage\": \"EN\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/","description":"

Use this endpoint to create a single user. If a user is successfully created, the response will include the user id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
debtorId	no
firstName	no
middleName	no
lastName	no
fullName	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
company	no
parent	no
pricelistAmount	no
pricelistPercentage	no
taxNumber	no
cocNumber	no
primaryLanguage	no
sourceId	no
source	only when `sourceId` is provided

Use this endpoint to retrieve user details by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. source and language for lookup key source).

Use expands as a query parameter to fetch additional information for users like sources, parent, etc.

sources: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the sources property in the response will be just an empty array.\nparent: use this value in the expands query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a user can be a resource of type usergroup

\n","type":"text/plain"},"key":"expands","value":"sources,parent"}],"variable":[{"description":{"content":"

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14760","key":"lookupValue"}]}},"response":[{"id":"f67fae57-ee30-4704-aa07-d8739fd8b89b","name":"GET User by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `sourceId`\n\n`id` - Integer, `sourceId` - string\n"},{"key":"lookupValue","value":"14760","description":"The `id` or `sourceId` of the user\n \n`id` - Integer, `sourceId` - String\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"372"},{"key":"date","value":"Thu, 24 Mar 2022 00:08:42 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"2a229c2b-5062-43e9-961b-ea535dda6390"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ssn\": \"\",\n \"company\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fullName\": \"Miles McCoy\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"vatNumber\": \"\",\n \"firstName\": \"Miles\",\n \"id\": 14760,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"639ce385-bd3f-490e-b0b2-2b01d43b47db","name":"Get User by id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `sourceId`\n\n`id` - Integer, sourceId - string\n"},{"key":"lookupValue","value":"146221"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"161"},{"key":"date","value":"Wed, 16 Mar 2022 17:26:57 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"4ac42aa6-87c5-41e1-9034-d1b09fe5a0da"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70006\",\n \"messages\": [\n \"User with id [146221] not found\"\n ],\n \"status\": 404,\n \"code\": 70006,\n \"type\": \"UserNotFound\"\n }\n}"},{"id":"d1cbb317-f714-48ac-9422-e701d1cec4f9","name":"Get User by ld - 400 (invalid lookupkey)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id1","description":"Use `id` or `sourceId`\n\n`id` - Integer, sourceId - string\n"},{"key":"lookupValue","value":"146221"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"219"},{"key":"date","value":"Wed, 16 Mar 2022 17:27:46 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e32401da-1c99-40c7-a60a-039ff9b0246f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"},{"id":"ce20eeca-3f88-4ba6-a01a-a8780a782a18","name":"GET User by lookup key - 200 (expands: sources, parent)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue?expands=sources,parent","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"sources,parent","description":"Use `expands` as a query parameter to fetch additional information for users like sources, parent, etc.\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a user can be a resource of type `usergroup`"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"707"},{"key":"Date","value":"Wed, 22 Jun 2022 07:27:33 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ssn\": \"\",\n \"sources\": [],\n \"company\": \"Propellor\",\n \"debtorId\": \"000002\",\n \"lastName\": \"Pflieger\",\n \"mobile\": \"06123456789\",\n \"abbreviation\": \"KP\",\n \"fullName\": \"Karl Pflieger\",\n \"dateOfBirth\": \"July, 22 1986 00:00:00 +0000\",\n \"gender\": \"M\",\n \"vatNumber\": \"\",\n \"firstName\": \"Karl\",\n \"id\": 14550,\n \"middleName\": \"\",\n \"login\": \"k.pflieger\",\n \"phone\": \"\",\n \"parent\": {\n \"userManagerId\": \"\",\n \"sources\": [],\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"Whitepaper Download\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"id\": 119,\n \"name\": \"Whitepaper Download\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 221701\n },\n \"title\": \"Mr\",\n \"email\": \"info@propellor.eu\"\n },\n \"messages\": [],\n \"total\": 1\n}"}],"_postman_id":"0f80dcf2-7c5d-4273-9d16-5c839386e1b8"},{"name":"Update User by lookup key","event":[{"listen":"test","script":{"id":"c6fcec5d-6b43-47b0-b73e-5a604263a3fa","exec":["pm.test(\"Response time is less than 200ms\", () => {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r","let jsonData = pm.response.json();\r","pm.test(\"Total updated products to equal 1\", function () {\r"," pm.expect(jsonData.total).to.eql(1);\r","});"],"type":"text/javascript"}}],"id":"1109ebc1-fe20-4204-884f-e454d4307975","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"login\": \"miles@propel.us\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","description":"

Use this endpoint to update user by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. source and language for lookup key source).

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14760","key":"lookupValue"}]}},"response":[{"id":"5be925c1-d33a-4d6b-b4d6-8dcfd6918af7","name":"Update User by id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"login\": \"miles@propel.us\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14760","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"322"},{"key":"date","value":"Wed, 20 Apr 2022 16:35:38 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"9da109f0-cf0f-488c-a33f-0394aa0ea289"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"parent\": {\n \"id\": 119\n },\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"abbreviation\": \"MM\",\n \"debtorId\": 12345,\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"dateOfBirth\": \"28/08/1993\",\n \"title\": \"Mr.\",\n \"gender\": \"M\",\n \"login\": \"miles@propel.us\",\n \"source\": \"RESTAPI\",\n \"sourceId\": 3002196,\n \"id\": 14760\n },\n \"messages\": [\n \"User updated\"\n ],\n \"total\": 1\n}"},{"id":"cf00490b-2a43-4f3a-b52d-0a05500fec7f","name":"Update User by id - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"login\": \"miles@propel.us\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"1476036","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"162"},{"key":"date","value":"Wed, 20 Apr 2022 16:36:03 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"39d5e568-9da4-48b0-8c75-6639d95c1a70"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70006\",\n \"messages\": [\n \"User with id [1476036] not found\"\n ],\n \"status\": 404,\n \"code\": 70006,\n \"type\": \"UserNotFound\"\n }\n}"},{"id":"045b472d-e69c-4c1d-8e54-3f9cda9e87d2","name":"Update User by id - 400","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"login\": \"miles@propel.us\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"1476036","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"219"},{"key":"date","value":"Wed, 20 Apr 2022 16:36:40 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"d3892a5c-aa92-44de-8c5f-a972a1ca734e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"1109ebc1-fe20-4204-884f-e454d4307975"},{"name":"Delete User by lookup key","id":"87e0d11a-daa3-4843-b2c4-92822963b6b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","description":"

Delete a user by a specific lookupKey / lookupId combination. A deleted user will be moved to the Propeller Recycle bin. This means the deleted user can be restored, however, only via the Propeller backoffice.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14699","key":"lookupValue"}]}},"response":[{"id":"591e0381-3467-46b3-9daf-de7720e83998","name":"Delete User by id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"14699"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"41"},{"key":"date","value":"Wed, 16 Mar 2022 19:24:35 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"65898282-b59a-4574-8c18-33be933da50c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"User deleted\"\n ]\n}"},{"id":"92e2becb-70fb-4d1e-aff7-244b37d78b64","name":"Delete User by id - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"146991"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"167"},{"key":"date","value":"Wed, 16 Mar 2022 19:25:09 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e89819f6-3aec-4e94-87b9-1e7828ad5f05"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70006\",\n \"messages\": [\n \"User with sourceId [146991] not found\"\n ],\n \"status\": 404,\n \"code\": 70006,\n \"type\": \"UserNotFound\"\n }\n}"},{"id":"baaa5da1-4c8a-4dec-a4d7-e987028369be","name":"Delete User by id - 400","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id1"},{"key":"lookupValue","value":"146991"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"219"},{"key":"date","value":"Wed, 16 Mar 2022 19:25:42 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"7e028deb-28d7-4109-a1fa-142c08fde08c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"87e0d11a-daa3-4843-b2c4-92822963b6b8"},{"name":"Bulk Users by source id","id":"6bc5a5dc-654b-49c0-becd-2470180fe8d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"users\": [\r\n {\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196,\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": 200105,\r\n \"source\" : \"RESTAPI\"\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0032445888\",\r\n \"phone\": \"0032445888\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"EN\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"SHOW_ONACCOUNT\" ,\r\n \"class\": \"user\",\r\n \"type\": \"enum\",\r\n \"value\": \"N\"\r\n },\r\n {\r\n \"name\": \"SHOW_PAYPAL\" ,\r\n \"class\": \"user\",\r\n \"type\": \"enum\",\r\n \"value\": \"Y\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/bulk/sourceId","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk sourceId endpoint, the users are identified by sourceId, source and language. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go here.

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go here.

A single users attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple users, this endpoint should be used.

Fields

Name	Required
users (array of users)	yes
source	yes
sourceId	yes
debtorId	no
firstName	no
middleName	no
lastName	no
fullName	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
company	no
parent	no
pricelistAmount	no
pricelistPercentage	no
taxNumber	no
cocNumber	no
primaryLanguage	no
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go here.

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go here.

Fields

Name	Required
users (array of users)	yes
source	yes
sourceId	yes
debtorId	no
firstName	no
middleName	no
lastName	no
fullName	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
company	no
parent	no
pricelistAmount	no
pricelistPercentage	no
taxNumber	no
cocNumber	no
primaryLanguage	no
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk id endpoint, the products are identified by id. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go here.

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go here.

Fields

Name	Required
users (array of users)	yes
id	yes
debtorId	no
firstName	no
middleName	no
lastName	no
fullName	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
company	no
parent	no
pricelistAmount	no
pricelistPercentage	no
taxNumber	no
cocNumber	no
primaryLanguage	no
sourceId	no
source	only when sourceId is provided
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

\n
The users search endpoint is only available on the Propeller cloud version.
\n

Retrieves a list of users by using the search fields below. Results will be paginated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
debtorIds	array(string)
dateCreated	DateFilter
dateModified	DateFilter
offset	integer
page	integer

Date filter

A date filter is a special date search object that can search through a range:

{\n    \"from\": \"2020-12-12T00:00:00\",\n    \"to\": \"2022-12-12T00:00:00\"\n}\n\n

Use expands as a query parameter to fetch additional information for users like sources, parent, etc.\nsources: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the sources property in the response will be just an empty array.

\n","type":"text/plain"},"key":"expands","value":"sources"}],"variable":[]}},"response":[{"id":"b309fb53-9bba-4972-bd28-a6e3672bdaca","name":"Search Users - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"debtorIds\": [\"12345\",\"9943212\"],\r\n \"dateCreated\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"2691"},{"key":"date","value":"Wed, 30 Aug 2023 10:30:04 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"8f5dfb64-8541-4928-9fd2-5ba9104cb276"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ssn\": \"\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-12T20:07:03\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"taxNumber\": \"\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-05-12T20:07:04\",\n \"fullName\": \"Miles McCoy\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"firstName\": \"Miles\",\n \"id\": 25474,\n \"iban\": \"\",\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n {\n \"ssn\": \"\",\n \"company\": \"\",\n \"dateModified\": \"2023-07-14T20:18:55\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"taxNumber\": \"\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-07-14T20:18:56\",\n \"fullName\": \"Miles McCoy\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"firstName\": \"Miles\",\n \"id\": 25515,\n \"iban\": \"\",\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n {\n \"ssn\": \"\",\n \"company\": \"\",\n \"dateModified\": \"2023-07-14T20:19:27\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"taxNumber\": \"\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-07-14T20:19:28\",\n \"fullName\": \"Miles McCoy\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"firstName\": \"Miles\",\n \"id\": 25516,\n \"iban\": \"\",\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"1.miles@propel.us\"\n },\n {\n \"ssn\": \"\",\n \"company\": \"\",\n \"dateModified\": \"2023-07-14T20:19:46\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"taxNumber\": \"\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-07-14T20:19:46\",\n \"fullName\": \"Miles McCoy\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"firstName\": \"Miles\",\n \"id\": 25517,\n \"iban\": \"\",\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us.com\"\n },\n {\n \"ssn\": \"\",\n \"company\": \"\",\n \"dateModified\": \"2023-07-14T20:21:00\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"taxNumber\": \"\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-07-14T20:21:01\",\n \"fullName\": \"Miles McCoy\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"firstName\": \"Miles\",\n \"id\": 25518,\n \"iban\": \"\",\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us.com\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 1,\n \"total\": 5,\n \"offset\": 12,\n \"itemsFound\": 5,\n \"end\": 5,\n \"page\": 1\n}"},{"id":"8b7be20f-95c3-47cb-9b3a-dbd48fc673bd","name":"Search Users - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sander\",\r\n \"dateCreated\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/users/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 22 Aug 2023 08:11:52 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"af1085fc-0046-4a42-8dd8-530b5fbe81b7"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"56568827-836d-4cc8-84be-855b1f6a5a28"}],"id":"3196e852-81fe-4b86-ba96-ed896e74cd55","description":"

Users represent data about a specific customer. Carts, orders, attributes, addresses are associated with users.

In a B2C environment a user is the actual customer ordering products, in a B2B environment a user is often part of a usergroup representing the organisation he/she is working for. Orders in a B2B environment are still placed by a specific user but connected to the organisation by a single debtorIdwhich is associated with the user.

User Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller `user` id
sourceId	string	External system unique id. sourceId should be combined with source

What are lookup keys?

Fields

Name	Description	Type
debtorId	A unique id representing this user. A debtorId can be automatically generated by Propellor	integer string
firstName	User first name	string
middleName	User middle name	string
lastName	User last name	string
fullName	User full name	string
title	User title	string
dateOfBirth	User date of birth	date
gender	User gender	enum m=Male f=Female u=Undefined
login	Login name used to login to the webshop	string
phone	User phone number	integer
email	A valid email address	string
company	Organization the user is working for	string
parent	Parent usergroup	JSON object that identifies the parent. `id` or `sourceId` in combination with source
pricelistAmount	A `pricesheet` code in case of special pricing agreements	string
pricelistPercentage	A `pricesheet` code in case of special pricing agreements	string
taxNumber	The VAT number of the financial entity this user is part of	string
cocNumber	The chamber of commerce number of the financial entity this user is part of	string
primaryLanguage	User primary language	ISO 639-1
sourceId	External system unique id	string
source	External system	string

User Errors

This section describes error codes specific for the User resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
70004	UserExists	400	User already exists	User with such lookup key already exists
70005	UserMultipleFound	400	Multuple users found. Please provide additional filters	Multiple users with such lookup key exist
70006	UserNotFound	404	User does not exist	User with such lookup key not found
70007	ParentUserNotFound	404	Parent user not found	Parent user with such lookup key not found. This error is typical when working with user sub-resources (e.g. attributes, addresses)
90006	AddressNotFound	404	Address does not exist	User address does not exist

","event":[{"listen":"prerequest","script":{"id":"59b408b5-7221-4fe0-a457-0d2f446cce1d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45034fc6-a5a8-4efe-9c78-81a57e3aaed5","type":"text/javascript","exec":[""]}}],"_postman_id":"3196e852-81fe-4b86-ba96-ed896e74cd55","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Usergroups","item":[{"name":"Addresses","item":[{"name":"Create Address","id":"d5fbc86e-44de-45d1-abe7-6a9757044c87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/","description":"

Use this endpoint to create an address for a usergroup. If the address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	no
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"122","key":"lookupValue"}]}},"response":[{"id":"9a762e0e-df08-4be3-9464-d5a50acb8dea","name":"Create Address - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"418"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c5d9386a-4819-45c5-850d-1128b3787284"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"delivery\",\n \"code\": \"11234\",\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"street\": \"Noordpad\",\n \"postalCode\": \"6822 DE\",\n \"city\": \"Arnhem\",\n \"icp\": \"N\",\n \"country\": \"NL\",\n \"region\": \"\",\n \"number\": \"34\",\n \"numberExtension\": \"A\",\n \"notes\": \"Address notes\",\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"company\": \"Propel\",\n \"url\": \"www.propel.us\",\n \"isDefault\": \"Y\",\n \"id\": 81918\n },\n \"messages\": [\n \"Address created\"\n ],\n \"total\": 1\n}"},{"id":"6212de74-c87f-43a5-8ea8-0ece6c86fc0e","name":"Create Address - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"U\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"183"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:47 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"ce74f222-eb05-4569-a753-7d546f3c85af","name":"Create Address - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"12256","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Thu, 17 Mar 2022 01:14:19 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Usergroup] with id [12256] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentUsergroupNotFound\"\n }\n}"}],"_postman_id":"d5fbc86e-44de-45d1-abe7-6a9757044c87"},{"name":"Bulk Addresses","id":"49c37fe7-0eb4-42da-946c-538043c249aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/bulk","description":"

Use this endpoint to create multiple usergroup addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	yes
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"9e8bfb80-cd65-4b31-a8b1-f1dd7dc19221","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"122","key":"lookupValue"}]}},"response":[{"id":"93aae71d-e356-44cb-90a3-9d2a34531da4","name":"Bulk Addresses - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"418"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c5d9386a-4819-45c5-850d-1128b3787284"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"delivery\",\n \"code\": \"11234\",\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"street\": \"Noordpad\",\n \"postalCode\": \"6822 DE\",\n \"city\": \"Arnhem\",\n \"icp\": \"N\",\n \"country\": \"NL\",\n \"region\": \"\",\n \"number\": \"34\",\n \"numberExtension\": \"A\",\n \"notes\": \"Address notes\",\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"company\": \"Propel\",\n \"url\": \"www.propel.us\",\n \"isDefault\": \"Y\",\n \"id\": 81908\n },\n \"messages\": [\n \"Address created\"\n ],\n \"total\": 1\n}"},{"id":"bb2c5dcb-ec36-458d-8aff-cae35e90c888","name":"Bulk Addresses - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"U\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"183"},{"key":"date","value":"Thu, 17 Mar 2022 01:12:47 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"6c44c2b8-58ea-401c-acee-53691fabc9f4","name":"Bulk Addresses - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"105","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Thu, 17 Mar 2022 01:14:19 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [147601] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"49c37fe7-0eb4-42da-946c-538043c249aa"},{"name":"Get Usergroup Addresses by type","id":"6da43635-1b00-4219-a46b-1a2f8a04b8fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/?type=delivery","description":"

Use this endpoint to retrieve a list of all usergroup addresses. Addresses can be filtered by type.

Optional. Only retrieve a certain type of address. Possible values:

delivery\ninvoice\nhome

\n","type":"text/plain"},"key":"type","value":"delivery"}],"variable":[{"description":{"content":"

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"122","key":"lookupValue"}]}},"response":[{"id":"99da75e1-bbb2-44cb-8158-9cda5104abf9","name":"Get Usergroup Delivery Addresses by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Filter on address type:\n\ndelivery\n\ninvoice"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"464"},{"key":"date","value":"Mon, 21 Mar 2022 18:50:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"7ba7b832-624b-49ee-ba0d-993be90732a3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 81918,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"N\",\n \"email\": \"miles@propel.us\"\n }\n ],\n \"messages\": [],\n \"total\": 1\n}"},{"id":"1470fa96-9885-49e2-9039-19c54d41301e","name":"Get Usergroup Delivery Addresses by id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Filter on address type:\n\ndelivery\n\ninvoice"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"12256","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Mon, 21 Mar 2022 18:50:40 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"ac58aef4-a7f5-426b-a374-170218dffed2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Usergroup] with id [12256] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentUsergroupNotFound\"\n }\n}"}],"_postman_id":"6da43635-1b00-4219-a46b-1a2f8a04b8fd"},{"name":"Get Address by id","id":"8aec2e20-53ff-4911-b802-b12855a255a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to retrieve details for a usergroup address. The address is identified by id.

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"122","key":"lookupValue"},{"description":{"content":"

id of the address

\n","type":"text/plain"},"type":"any","value":"81918","key":"addressId"}]}},"response":[{"id":"bd461984-8747-4e39-a541-759140a99d7f","name":"Get Address by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81918","description":"id of the address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"462"},{"key":"date","value":"Mon, 21 Mar 2022 18:54:28 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"14bcc898-8faa-46c0-bfae-56ebd5c4464c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 81918,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"N\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"bccdb863-f596-4c0f-acd4-61fcc1354b92","name":"Get Address by id - 404 (address not found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"819181","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"195"},{"key":"date","value":"Mon, 21 Mar 2022 18:55:33 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"8db2c1e7-369e-44c2-8a09-bc6c4364e0a0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [819181] not found for [Usergroup] with id [122]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"},{"id":"8405cbf2-54f6-4dd5-a0fa-52e75a72a369","name":"Get Address by id - 404 (usergroup not found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"12256","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81918","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"194"},{"key":"date","value":"Wed, 20 Apr 2022 20:56:59 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"1e3114dc-c91a-4d93-8750-fafdee3ea687"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Usergroup] with id [12256] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentUsergroupNotFound\"\n }\n}"}],"_postman_id":"8aec2e20-53ff-4911-b802-b12855a255a2"},{"name":"Update Address","id":"9b8b8d9d-525f-41a5-bdac-cc9524245ec3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to update a usergroup address. The address is identified by id.

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"122","key":"lookupValue"},{"description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"81918","key":"addressId"}]}},"response":[{"id":"90a45dfc-9d26-44f4-956d-f30cd117149a","name":"Update Address by id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81918","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"103"},{"key":"date","value":"Mon, 21 Mar 2022 19:12:27 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"820885e1-1675-4bf5-a07b-f418962b891d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"firstName\": \"Miles\",\n \"lastName\": \"McCoy\",\n \"id\": 81918\n },\n \"messages\": [\n \"Address updated\"\n ],\n \"total\": 1\n}"},{"id":"9dd5b7be-5f5c-4525-91ca-24b869dd1845","name":"Update Address by id - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"12256","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81918","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"185"},{"key":"date","value":"Wed, 20 Apr 2022 18:25:06 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"ca307bd2-10cd-4551-a516-3b9f702fe1a6"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Usergroup] with id [12256] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentUsergroupNotFound\"\n }\n}"},{"id":"a7cb0261-aa82-4191-9e46-b8d87f10bddc","name":"Update Address by id - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstNames\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81918","description":"Address id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"190"},{"key":"date","value":"Wed, 20 Apr 2022 18:25:49 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"6c032004-3b98-412d-b4ae-bd732ffb4748"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [firstNames] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"9b8b8d9d-525f-41a5-bdac-cc9524245ec3"},{"name":"Delete Address","id":"346d607b-d118-4b0f-99ea-e3c823211a95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to delete a usergroup's address. The address is identified by id.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"14760","key":"lookupValue"},{"description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"81918","key":"addressId"}]}},"response":[{"id":"3ef7eec6-4318-4993-bf26-10b9f35c2b86","name":"Delete Address by id - 200","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81918","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Wed, 20 Apr 2022 19:23:22 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"130478fb-d22e-45a6-90ed-1980abc20734"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Address deleted\"\n ]\n}"},{"id":"fc556c3e-ebe8-4792-b87d-8973e6596cc5","name":"Delete Address by id - 404 (user not found)","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"12256","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"81918","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"185"},{"key":"date","value":"Wed, 20 Apr 2022 19:21:54 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c1936ffe-6011-4400-937b-3cbe71fdf4d8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Usergroup] with id [12256] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentUsergroupNotFound\"\n }\n}"},{"id":"aab4fe14-7ed5-4379-8dce-6e8fe4ecdc96","name":"Delete Address by id - 404 (address not found)","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"819189","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"195"},{"key":"date","value":"Wed, 20 Apr 2022 19:22:30 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"50bca6e1-d150-4256-97a3-aa52d77a14a2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [819189] not found for [Usergroup] with id [122]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"346d607b-d118-4b0f-99ea-e3c823211a95"}],"id":"0aab9e51-a28f-4ce2-a98e-45b15122a4a5","description":"

The Usergroup Addresses endpoints can be used to manage usergroup addresses. A usergroup can have multiple addresses of different type: delivery, invoice.

Fields

Name	Description	Type
type	Address type	enum delivery invoice
code	Address code	string
firstName	First name	string
middleName	Middle name	string
lastName	Last name	string
gender	Gender	enum M=Male F=Female U=Undefined
street	Street	string
number	Number	string
numberExtension	Number extension	string
postalCode	Postal code	string
city	City	string
country	Country	string
region	Region	string
icp	Indicates whether tax should be calculated when goods are delivered at this address	enum Y = Yes N = No
phone	Phone number	string
mobile	Mobile number	string
email	A valid email address	string
company	Organization the address is located at (if any)	string
url	Website	string
isDefault	Is this address the default address for the user of the provided type?	enum Y = Yes N = No
notes	Helpful notes for locating the address, etc.	string

","_postman_id":"0aab9e51-a28f-4ce2-a98e-45b15122a4a5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Pricing","item":[{"name":"Create Usergroup Pricing","id":"fce87cf4-8601-4246-be80-6b8457bb7dba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 1036522,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to define pricing for an existing usergroup. The usergroup can be identified by it's lookup key. It is required to provide either categories or products or both in the payload.

Use cases

A common use case for this endpoint is when you want to give discounts only for a specific usergroup and all users in that usergroup. If a user in that usergroup already has pricing defined, the price set on the parent usergroup will be ignored.

If you want for ex. to give a discount of 20% of sales price on all products in a given category you can use the SP type pricing for a category. The usergroup will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for users in a given usergroup.

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"122","key":"lookupValue"}]}},"response":[{"id":"3533962c-5f24-46c7-a31d-bdc5cc1d3144","name":"Create Usergroup Pricing - 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 1036522,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"287"},{"key":"date","value":"Wed, 20 Apr 2022 15:40:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"463a1983-f185-4027-9906-e95c8884711e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": 1797,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 77138,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"error\": \"product with id [1036522] not found\",\n \"success\": false,\n \"key\": 1036522,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"completed\"\n ],\n \"total\": 3\n}"},{"id":"7f5639ee-b495-46d8-be58-f94fbfdc6b30","name":"Create Usergroup Pricing - 404","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 1036522,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122589","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"197"},{"key":"date","value":"Wed, 20 Apr 2022 15:31:09 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a009a732-a593-4242-aed6-0ad86535ca35"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Usergroup] with id [122589] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentUsergroupNotFound\"\n }\n}"}],"_postman_id":"fce87cf4-8601-4246-be80-6b8457bb7dba"},{"name":"Delete Usergroup Pricing","id":"4683c042-6e08-4256-b3b0-29da5d21f526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to delete pricing for an existing usergroup. The usergroup can be identified by it's lookup key.

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"122","key":"lookupValue"}]}},"response":[{"id":"8d6f171f-e991-4c5c-9432-7d5389b28f82","name":"Delete Usergroup Pricing - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122586","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"197"},{"key":"date","value":"Wed, 20 Apr 2022 15:41:31 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"2fb9ab1b-d503-41ee-8aeb-4a00acd52df8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Usergroup] with id [122589] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentUsergroupNotFound\"\n }\n}"},{"id":"5871a472-c1d4-416a-9e8c-9c4dca93ecf3","name":"Delete Usergroup Pricing - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Wed, 20 Apr 2022 15:42:50 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b695bd56-0a13-49d7-9213-ef5c80735da2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"}],"_postman_id":"4683c042-6e08-4256-b3b0-29da5d21f526"}],"id":"ee5b3d7d-8513-47b0-aaed-ed6d75dbfa75","description":"

The Usergroup Pricing endpoints can be used to manage pricing for usergroups. Read more about pricing to learn more details.

\n","_postman_id":"ee5b3d7d-8513-47b0-aaed-ed6d75dbfa75","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Create Usergroup","id":"2f1e6228-ece2-45e7-b11d-61593b63aad1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"name\": \"Netherlands\",\r\n \"company\": \"\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"notes\": \"Usergroup created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/","description":"

Use this endpoint to create a single usergroup. If a usergroup is successfully created, the response will include the usergroup id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
name	no
language	no
parent	no
company	no
department	no
office	no
notes	no
inheritProductList	no Default is `Y`
inheritOrderList	no Default is `Y`
budget	no Default is `N`
budgetInherit	no Default is `Y`
orderListAllowAll	no Default is `U`
sourceId	no
source	only when sourceId is provided

Use this endpoint to retrieve usergroup details by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. source and language for lookup key source).

Use expands as a query parameter to fetch additional information for usergroups like sources, etc.

\n","type":"text/plain"},"key":"expands","value":"sources"}],"variable":[{"description":{"content":"

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"}]}},"response":[{"id":"54625c0b-ec5b-43a3-88d2-e386c537fd3a","name":"GET Usergroup by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"330"},{"key":"date","value":"Wed, 20 Apr 2022 21:16:49 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"16e19adf-9cf7-425a-be5d-d97a050f8b5e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"inheritOrderList\": \"N\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"Usergroup created from API\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"id\": 213,\n \"name\": \"Netherlands\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"80380ff8-bc99-44cf-b124-a14500aee090","name":"GET Usergroup by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"21315","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"170"},{"key":"date","value":"Wed, 20 Apr 2022 21:20:53 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"50d45de3-d8b4-4c73-a2c7-6c5208255c1f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20006\",\n \"messages\": [\n \"Usergroup with id [21315] not found\"\n ],\n \"status\": 404,\n \"code\": 20006,\n \"type\": \"UsergroupNotFound\"\n }\n}"},{"id":"352b0884-e2c5-4527-a78a-4814bce39295","name":"GET Usergroup by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Wed, 20 Apr 2022 21:21:36 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c5fa94d0-251c-4653-ae69-8869c77db00f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"},{"id":"0d6a5344-f3e5-4464-8a2c-a761be021ce2","name":"GET Usergroup by lookup key - 200 (expands: sources)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue?expands=sources","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"sources","description":"Use `expands` as a query parameter to fetch additional information for usergroups like sources, etc.\n`sources`: if the `expands` parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"348"},{"key":"Date","value":"Wed, 22 Jun 2022 07:29:14 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"userManagerId\": \"\",\n \"sources\": [],\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"Whitepaper Download\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"id\": 119,\n \"name\": \"Whitepaper Download\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 221701\n },\n \"messages\": [],\n \"total\": 1\n}"}],"_postman_id":"8802d2cd-be86-4060-b5a6-90ecc6bcdaa6"},{"name":"Update Usergroup by lookup key","event":[{"listen":"test","script":{"id":"c6fcec5d-6b43-47b0-b73e-5a604263a3fa","exec":["pm.test(\"Response time is less than 200ms\", () => {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r","let jsonData = pm.response.json();\r","pm.test(\"Total updated products to equal 1\", function () {\r"," pm.expect(jsonData.total).to.eql(1);\r","});"],"type":"text/javascript"}}],"id":"64224fcb-cbe2-4144-bc23-a82eca8126c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"name\": \"Netherlands\",\r\n \"company\": \"\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"notes\": \"Usergroup created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","description":"

Use this endpoint to update usergroup by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. source and language for lookup key source).

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"}]}},"response":[{"id":"7eba71bd-4740-4cdc-a004-6557df5b6501","name":"Update Usergroup by id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"name\": \"Netherlands\",\r\n \"company\": \"\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"notes\": \"Usergroup created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"264"},{"key":"date","value":"Wed, 20 Apr 2022 21:25:57 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"21ad3351-2544-4e19-aef2-f01cc4a8e717"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"parent\": {\n \"id\": 119\n },\n \"name\": \"Netherlands\",\n \"company\": \"\",\n \"department\": \"\",\n \"office\": \"\",\n \"notes\": \"Usergroup created from API\",\n \"inheritProductList\": \"Y\",\n \"inheritOrderList\": \"N\",\n \"budget\": \"N\",\n \"budgetInherit\": \"N\",\n \"id\": 213\n },\n \"messages\": [\n \"Usergroup updated\"\n ],\n \"total\": 1\n}"},{"id":"81b44200-53ac-470e-bea6-404ef662e1b0","name":"Update Usergroup by id - 400","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"name\": \"Netherlands\",\r\n \"company\": \"\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"notes\": \"Usergroup created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Wed, 20 Apr 2022 21:24:24 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"43fe9d1b-48cf-4880-b5b7-e92423f3deb6"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"},{"id":"ecd2bccb-2a7e-421c-8c57-cad2cc09b246","name":"Update Usergroup byid - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 119\r\n },\r\n \"name\": \"Netherlands\",\r\n \"company\": \"\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"notes\": \"Usergroup created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"21317","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"170"},{"key":"date","value":"Wed, 20 Apr 2022 21:26:33 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b9a1f56f-f834-48fb-92ec-15385c2bee0b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20006\",\n \"messages\": [\n \"Usergroup with id [21317] not found\"\n ],\n \"status\": 404,\n \"code\": 20006,\n \"type\": \"UsergroupNotFound\"\n }\n}"}],"_postman_id":"64224fcb-cbe2-4144-bc23-a82eca8126c3"},{"name":"Delete Usergroup by lookup key","id":"faf643ab-1ffc-41cd-a58d-3c7898f394f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","description":"

Delete a usergroup by a specific lookupKey / lookupId combination. A deleted usergroup will be moved to the Propeller Recycle bin. This means the deleted usergroup can be restored, however, only via the Propeller backoffice.

Lookup key. Read more about usergroup lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"}]}},"response":[{"id":"a18816c3-a9d6-4878-be6b-1621745fd0a0","name":"Delete Usergroup by id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"46"},{"key":"date","value":"Wed, 20 Apr 2022 21:30:50 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"8319c262-f4a5-478c-9f75-ea4fe0ac8f0b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Usergroup deleted\"\n ]\n}"},{"id":"db308bb7-afc5-4824-ae82-ab580c0b7db0","name":"Delete Usergroup by id - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"21317","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"176"},{"key":"date","value":"Wed, 20 Apr 2022 21:31:30 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"2fbd9182-9077-41c6-8cae-9dca0fab89ad"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20006\",\n \"messages\": [\n \"Usergroup with id [21317] not found\"\n ],\n \"status\": 404,\n \"code\": 20006,\n \"type\": \"UsergroupNotFound\"\n }\n}"},{"id":"cfce7ade-829d-4d67-8bc3-ee0dafad9746","name":"Delete Usergroup by id - 400","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/usergroups/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["usergroups",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"21317","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Wed, 20 Apr 2022 21:34:55 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e918f7a3-5711-4366-a224-0f8f71e10c2f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"faf643ab-1ffc-41cd-a58d-3c7898f394f3"},{"name":"Bulk Usergroups by source id","id":"09987f50-b5c1-4877-b0c0-89131e731619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"usergroups\": [\r\n {\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 100001,\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": 100000\r\n },\r\n \"name\": \"Netherlands\",\r\n \"company\": \"\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"notes\": \"Usergroup created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\",\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipMoveOnUpdate\",\r\n \"fields\": []\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/bulk/sourceId","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk sourceId endpoint, the usergroups are identified by sourceId, source and language. If a usergroup doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.

Usergroup Bulk endpoints support bulk change of attributes for multiple usergroups as well. To learn more about Attributes, go here.

Usergroup Bulk endpoints support bulk change of pricing for multiple usergroups as well. To learn more about Pricing, go here.

A single usergroup's attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple usergroups in a single call, this endpoint should be used.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
usergroups (array of usergroup objects)	yes
source	yes
sourceId	yes
name	no
language	yes
parent	no
company	no
department	no
office	no
notes	no
inheritProductList	no Default is `Y`
inheritOrderList	no Default is `Y`
budget	no Default is `N`
budgetInherit	no Default is `Y`
orderListAllowAll	no Default is `U`
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing usergroup that are not empty	array of field names e.g. name, company etc.
skipMoveOnUpdate	On update, skip moving an existing usergroup in the parent provided	empty array

What are directives?

The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk id endpoint, the usergroups are identified by id. If a usergroup with such id doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.

Usergroup Bulk endpoints support bulk change of attributes for multiple usergroups as well. To learn more about Attributes, go here.

Usergroup Bulk endpoints support bulk change of pricing for multiple usergroups as well. To learn more about Pricing, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
usergroups (array of usergroup objects)	yes
id	yes
name	no
language	no
parent	no
company	no
department	no
office	no
notes	no
inheritProductList	no Default is `Y`
inheritOrderList	no Default is `Y`
budget	no Default is `N`
budgetInherit	no Default is `Y`
orderListAllowAll	no Default is `U`
sourceId	no
source	only when sourceId is provided
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing usergroup that are not empty	array of field names e.g. name, company etc.
skipMoveOnUpdate	On update, skip moving an existing usergroup in the parent provided	empty array

What are directives?

\n
The usergroups search endpoint is only available on the Propeller cloud version.
\n

Retrieves a list of usergroups by using the search fields below. Results will be paginated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
dateCreated	DateFilter
dateModified	DateFilter
offset	integer
page	integer

Date filter

A date filter is a special date search object that can search through a range:

{\n    \"from\": \"2020-12-12T00:00:00\",\n    \"to\": \"2022-12-12T00:00:00\"\n}\n\n

Use expands as a query parameter to fetch additional information for usergroups like sources, parent, etc.\nsources: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the sources property in the response will be just an empty array.

\n","type":"text/plain"},"key":"expands","value":"sources"}],"variable":[]}},"response":[{"id":"6dcfd74b-dc82-42ac-9d94-9ccc5fcee959","name":"Search Usersgroups - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"dateCreated\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"4374"},{"key":"date","value":"Wed, 30 Aug 2023 10:33:40 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"52f3bb33-25b9-4ee5-9dfb-0d08f829a9ba"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"Propellor Sonar Root\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-10-10T15:39:26\",\n \"id\": 102,\n \"name\": \"Propellor Sonar Root\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 0\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-10-10T15:39:26\",\n \"id\": 103,\n \"name\": \"Propellor Sonar Propellor\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 100052\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"Propellor Sonar ROOT\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-10-10T15:52:05\",\n \"id\": 106,\n \"name\": \"Propellor Sonar ROOT\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 228955\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-10-18T17:10:00\",\n \"id\": 107,\n \"name\": \"Nieuwsbrief 2\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 227050\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-10-20T13:44:49\",\n \"id\": 108,\n \"name\": \"Propellor Sonar Vestigingen\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 199539\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"Trimergo\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-10-24T10:32:51\",\n \"id\": 109,\n \"name\": \"Customer root\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 227298\n },\n {\n \"userManagerId\": \"200008\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-10-24T10:33:11\",\n \"id\": 110,\n \"name\": \"Particulier\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 476428\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"N\",\n \"dateCreated\": \"2017-10-24T10:34:36\",\n \"id\": 111,\n \"name\": \"Zakelijk\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 201073\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-11-07T10:57:19\",\n \"id\": 112,\n \"name\": \"Temp\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 227128\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2017-11-07T11:01:36\",\n \"id\": 113,\n \"name\": \"Onderwijs\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 200942\n },\n {\n \"userManagerId\": \"200008\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"N\",\n \"dateCreated\": \"2017-12-04T14:43:23\",\n \"id\": 114,\n \"name\": \"Bestellers\",\n \"authorizeId\": \"200008\",\n \"defaultobjectId\": 200007\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-03-22T12:01:39\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"dateCreated\": \"2018-02-05T13:19:50\",\n \"id\": 115,\n \"name\": \"System\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 200036\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 9,\n \"total\": 12,\n \"offset\": 12,\n \"itemsFound\": 107,\n \"end\": 12,\n \"page\": 1\n}"},{"id":"af5ae9d7-0b0c-490f-9c66-223acbc7467a","name":"Search Usersgroups - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sander\",\r\n \"dateCreated\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/usergroups/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 22 Aug 2023 08:31:19 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"991f5cfe-9880-4959-bc5c-3aa2fc2d678e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"fe94576b-ca93-4768-812d-9aca70e5b931"}],"id":"5902a2ba-9a81-45d8-b96b-e62328ea774a","description":"

Usergroups are used to group users or other usergroups together. This parent - child relationship i.e. tree organizational structure is very powerful because it allows inheriting settings, permissions, pricing, etc. A usergroup can even represent a company in a B2B environment, although this concept will soon be deprecated and a dedicated Companies resource will be introduced.

Usergroup Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller `usergroup` id
sourceId	string	External system unique id. sourceId should be combined with source

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
name	Usergroup name	string
language	Default system language	string ISO 639-1
parent	Parent usergroup	JSON object that identifies the parent. `id` or `sourceId` in combination with `source`
company	Company	string
department	Department	string
office	Office	string
notes	Notes	string
inheritProductList	Indicates whether pricing should be inherited from parent usergroup	enum `Y` = Yes `N` = No
inheritOrderList	Indicates whether the order list should be inherited from the parent usergroup	enum `Y` = Yes `N` = No
budget	Usergroup budget settings	enum `Y` = Users in usergroup use budget and may only order products within budget `H` = Users in usergroup use budget and may also order products outside budget `N` = Users in usergroup do not use budgets
budgetInherit	Indicates whether budget settings should be inherited from parent usergroup	enum `Y` = Yes `N` = No
orderListAllowAll	Order list settings	enum `N` = Order everything within the order list `Y` = Order everything outside the order list `A` = Order everything, but products outside the order list must be authorized `U` = Order everything `P` = Order restricted products
sourceId	External system unique id	string
source	External system	string

Usergroup Errors

This section describes error codes specific for the Usergroup resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
20004	UsergroupExists	400	Usergroup already exists	Usergroup with such lookup key already exists
20005	UsergroupMultipleFound	400	Multuple usergroups found. Please provide additional filters	Multiple usergroups with such lookup key exist
20006	UsergroupNotFound	404	Usergroup does not exist	Usergroup with such lookup key not found
20007	ParentUsergroupNotFound	404	Parent usergroup not found	Parent usergroup with such lookup key not found. This error is typical when working with usergroup sub-resources (e.g. attributes, addresses)
90006	AddressNotFound	404	Address does not exist	Usergroup address does not exist

","event":[{"listen":"prerequest","script":{"id":"59b408b5-7221-4fe0-a457-0d2f446cce1d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45034fc6-a5a8-4efe-9c78-81a57e3aaed5","type":"text/javascript","exec":[""]}}],"_postman_id":"5902a2ba-9a81-45d8-b96b-e62328ea774a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Companies","item":[{"name":"Addresses","item":[{"name":"Create Address","id":"a5168811-68ec-42f1-88fc-f4f9e06bc21b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/","description":"

Use this endpoint to create an address for a company. If the address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	no
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"8cf3573f-f9e9-4968-bf0e-93ee3aa35788","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"}]}},"response":[{"id":"57b40c34-0cd2-4fa7-9495-1d2a5d5e2bed","name":"Create Address - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"435"},{"key":"date","value":"Mon, 22 May 2023 15:50:22 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"d256d03e-fede-4805-95d4-f471102c6f12"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"delivery\",\n \"code\": \"11234\",\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"street\": \"Noordpad\",\n \"postalCode\": \"6822 DE\",\n \"city\": \"Arnhem\",\n \"icp\": \"N\",\n \"country\": \"NL\",\n \"region\": \"\",\n \"number\": \"34\",\n \"numberExtension\": \"A\",\n \"notes\": \"Address notes\",\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"company\": \"Propel\",\n \"url\": \"www.propel.us\",\n \"isDefault\": \"Y\",\n \"id\": 106076\n },\n \"messages\": [\n \"Address created\"\n ],\n \"total\": 1\n}"},{"id":"e93a909e-32aa-439e-994c-1e7d788fb82b","name":"Create Address - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9484","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"189"},{"key":"date","value":"Mon, 22 May 2023 15:50:59 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"2d5c8465-b685-4991-b97e-208888998e41"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40007\",\n \"messages\": [\n \"Parent resource [Company] with id [9484] not found\"\n ],\n \"status\": 404,\n \"code\": 40007,\n \"type\": \"ParentCompanyNotFound\"\n }\n}"},{"id":"a3f73fc7-8cf3-4b4a-adaf-2751a8ef6e83","name":"Create Address - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"U\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"183"},{"key":"date","value":"Mon, 22 May 2023 15:51:50 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"6222e57f-cdc2-457e-b60f-cc6cf823dda3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"a5168811-68ec-42f1-88fc-f4f9e06bc21b"},{"name":"Bulk Addresses","id":"e6a3c56e-ca5b-4e39-9127-2b148d117e8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/bulk","description":"

Use this endpoint to create multiple company addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	yes
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"c8c8ca72-8f0c-4c72-94bd-6bcd6c2c81a3","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"}]}},"response":[{"id":"40551b9b-5b88-46e2-ba55-f278d8da237f","name":"Bulk Addresses - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses","bulk"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"207"},{"key":"date","value":"Mon, 22 May 2023 15:53:21 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"84e830d7-05ce-4627-8b6d-f8fb16236a91"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": \"11234\",\n \"id\": 106076,\n \"action\": \"update\",\n \"lookupKey\": \"code\"\n },\n {\n \"success\": true,\n \"key\": \"11235\",\n \"id\": 106078,\n \"action\": \"create\",\n \"lookupKey\": \"code\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"b5b946c4-bd0a-45ad-ada3-10ac295d0ac7","name":"Bulk Addresses - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses","bulk"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9484","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"189"},{"key":"date","value":"Mon, 22 May 2023 15:53:53 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e51ea8eb-0138-41c3-bb23-445383026f55"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40007\",\n \"messages\": [\n \"Parent resource [Company] with id [9484] not found\"\n ],\n \"status\": 404,\n \"code\": 40007,\n \"type\": \"ParentCompanyNotFound\"\n }\n}"},{"id":"e9fc7a58-f174-42a8-bd12-c7e3e49967e4","name":"Bulk Addresses - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"U\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses","bulk"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"195"},{"key":"date","value":"Mon, 22 May 2023 15:54:22 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a4bce8dd-2acb-4ceb-9e82-010106021fb0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/addresses/0/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"e6a3c56e-ca5b-4e39-9127-2b148d117e8f"},{"name":"Get Addresses by type","id":"67382cae-b20d-4a98-80f0-b646ae77a72a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/?type=delivery","description":"

Use this endpoint to retrieve a list of all company addresses. Addresses can be filtered by type.

Optional. Only retrieve a certain type of address. Possible values:

delivery\ninvoice

\n","type":"text/plain"},"key":"type","value":"delivery"}],"variable":[{"id":"2c3dc014-0963-4609-a27b-afc7476c7e66","description":{"content":"

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"cd80181c-986d-485f-b82e-2e546b8aaafe","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"}]}},"response":[{"id":"e0867160-b1ca-46b5-89d1-e9032e28b304","name":"Get Addresses by type - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"892"},{"key":"date","value":"Mon, 22 May 2023 15:56:05 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"275bd3cd-ca81-4362-b495-344a198e551d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 106076,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"Y\",\n \"email\": \"miles@propel.us\"\n },\n {\n \"postalCode\": \"1016 XA\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"193\",\n \"street\": \"Lijnbaansgracht\",\n \"url\": \"www.propel.us\",\n \"code\": \"11235\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 106078,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Amsterdam\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"N\",\n \"email\": \"miles@propel.us\"\n }\n ],\n \"messages\": [],\n \"total\": 2\n}"},{"id":"de11ae7e-cc03-435a-b8e8-69a88c914113","name":"Get Addresses by type - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9484","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"189"},{"key":"date","value":"Mon, 22 May 2023 15:56:42 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c1189111-8b0e-46f5-b2fd-6e096e05620a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40007\",\n \"messages\": [\n \"Parent resource [Company] with id [9484] not found\"\n ],\n \"status\": 404,\n \"code\": 40007,\n \"type\": \"ParentCompanyNotFound\"\n }\n}"}],"_postman_id":"67382cae-b20d-4a98-80f0-b646ae77a72a"},{"name":"Get Address by id","id":"a0a68f64-e456-4ba8-9486-d1bbe2ac08df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to retrieve details for a company address. The address is identified by id.

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"b64c8996-a108-4851-9be7-40a083536dd0","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"},{"id":"8b99c8c6-110a-4a63-8278-497c75db0ba3","description":{"content":"

id of the address

\n","type":"text/plain"},"type":"any","value":"106076","key":"addressId"}]}},"response":[{"id":"6aec0600-c7d3-4fdb-8626-2a7b69bdbff4","name":"Get Address by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106076","description":"id of the address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"463"},{"key":"date","value":"Mon, 22 May 2023 15:58:37 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"56d32679-6c95-4870-bf16-f6c0e1de8088"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 106076,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"Y\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"ee44c67d-2dfa-49a3-9d74-b20aee9254bf","name":"Get Address by id - 404 (company)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9484","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106076","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"189"},{"key":"date","value":"Mon, 22 May 2023 15:59:14 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a114a5ea-01cf-4233-a166-4bb7d9585474"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40007\",\n \"messages\": [\n \"Parent resource [Company] with id [9484] not found\"\n ],\n \"status\": 404,\n \"code\": 40007,\n \"type\": \"ParentCompanyNotFound\"\n }\n}"},{"id":"09a82bef-2ba6-4e4e-b7d6-5f3278049b67","name":"Get Address by id - 404 (address)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106200","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"198"},{"key":"date","value":"Mon, 22 May 2023 16:00:00 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a00e5334-958b-4baa-8467-a366fca2cc24"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [106200] not found for [Companies] with id [9482]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"a0a68f64-e456-4ba8-9486-d1bbe2ac08df"},{"name":"Update Address","id":"66c1ebb6-63de-43a2-960c-db157831249d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to update a company address. The address is identified by id.

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"45dc7f3a-4794-4e37-876c-88a85d1d76f4","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"},{"id":"cd08faa2-1a01-4f8e-9cf9-a03818f785ed","description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"106076","key":"addressId"}]}},"response":[{"id":"96b1817c-53e4-4e02-8f53-d8acc4085b94","name":"Update Address - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106076","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"104"},{"key":"date","value":"Mon, 22 May 2023 16:11:36 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b91a8648-82c9-4758-b713-cbb6c6d070f8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"firstName\": \"Miles\",\n \"lastName\": \"McCoy\",\n \"id\": 106076\n },\n \"messages\": [\n \"Address updated\"\n ],\n \"total\": 1\n}"},{"id":"97ca1b69-8c6e-42a2-b9fc-b0190a18086c","name":"Update Address - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106276","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"198"},{"key":"date","value":"Mon, 22 May 2023 16:12:31 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"db28d417-3832-4182-b707-ae08089fe01b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [106276] not found for [Companies] with id [9482]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"},{"id":"7256cac4-9590-4df3-b50b-abe982184897","name":"Update Address - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\",\r\n \"town\": \"Amsterdam\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106076","description":"Address id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Mon, 22 May 2023 16:13:30 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"2e3defbe-90f4-4671-9a82-27acd949ff12"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [town] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"66c1ebb6-63de-43a2-960c-db157831249d"},{"name":"Delete Address","id":"497f31c9-3173-4ee2-99b5-a5a207ac6582","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to delete a company address. The address is identified by id.

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"9a6c997a-f306-4cb4-a971-bbf806dd7154","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"},{"id":"5aef3d2b-762a-4332-97a9-6e4cdc84713d","description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"106078","key":"addressId"}]}},"response":[{"id":"a470441c-6ed0-4481-91cf-2ca9ee5392d1","name":"Delete Address - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106078","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Mon, 22 May 2023 16:16:38 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a1ca47ef-14b0-40da-ab4a-19a58eb17024"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Address deleted\"\n ]\n}"},{"id":"84aca312-e107-44bf-aa2c-6c027f55de91","name":"Delete Address - 404 (company)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9484","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106078","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"189"},{"key":"date","value":"Mon, 22 May 2023 16:17:03 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"67f0ab32-49e5-41ad-a7d5-724f8810e249"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40007\",\n \"messages\": [\n \"Parent resource [Company] with id [9484] not found\"\n ],\n \"status\": 404,\n \"code\": 40007,\n \"type\": \"ParentCompanyNotFound\"\n }\n}"},{"id":"b924dccb-2477-47dc-96d6-c63bb9f7fa98","name":"Delete Address - 404 (address)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106077","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"198"},{"key":"date","value":"Mon, 22 May 2023 16:17:28 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"33e4d2a9-6688-457c-a5d2-605e3f3f5076"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [106077] not found for [Companies] with id [9482]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"497f31c9-3173-4ee2-99b5-a5a207ac6582"}],"id":"d166dbc9-47a4-4209-8cdc-5764e534024b","description":"

The Company Addresses endpoints can be used to manage company addresses. A company can have multiple addresses of different type: delivery, invoice.

Fields

Name	Description	Type
type	Address type	enum delivery invoice
code	Address code	string
firstName	First name	string
middleName	Middle name	string
lastName	Last name	string
gender	Gender	enum M=Male F=Female U=Undefined
street	Street	string
number	Number	string
numberExtension	Number extension	string
postalCode	Postal code	string
city	City	string
country	Country	string
region	Region	string
icp	Indicates whether tax should be calculated when goods are delivered at this address	enum Y = Yes N = No
phone	Phone number	string
mobile	Mobile number	string
email	A valid email address	string
company	Organization the address is located at (if any)	string
url	Website	string
isDefault	Is this address the default address for the company of the provided type?	enum Y = Yes N = No
notes	Helpful notes for locating the address, etc.	string

","_postman_id":"d166dbc9-47a4-4209-8cdc-5764e534024b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Pricing","item":[{"name":"Create Company Pricing","id":"6015b092-30b7-4e5f-aaa3-8bfa53d6e6f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\":[\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n } \r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to define pricing for an existing company. The company can be identified by it's lookup key. It is required to provide either categories or products or both in the payload.

Use cases

A common use case for this endpoint is when you want to give discounts only for a specific company and all contacts in that company. If a contact in that company already has pricing defined, the price set on the parent company will be ignored.

If you want for ex. to give a discount of 20% of sales price on all products in a given category you can use the SP type pricing for a category. The company will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for contacts in a given company.

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"14a0a0a9-87db-4ba9-94b8-f345d2464b8c","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"}]}},"response":[{"id":"6e644269-713c-4498-b35f-1d34bd6aeaff","name":"Create Company Pricing - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\":[\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n } \r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"238"},{"key":"date","value":"Mon, 22 May 2023 16:24:21 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"3e91bd07-65a7-47f5-ac76-f236b6c7ee09"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": 1797,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 77138,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 86011,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 3\n}"},{"id":"42e00205-b09d-46d6-8d98-9eb725aa70da","name":"Create Company Pricing - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\":[\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n } \r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9484","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"193"},{"key":"date","value":"Mon, 22 May 2023 16:25:06 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"cd3e6cdd-5a9b-45ca-b916-0c9b7216c1a5"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Company] with id [9484] not found\"\n ],\n \"status\": 404,\n \"code\": 40007,\n \"type\": \"ParentCompanyNotFound\"\n }\n}"}],"_postman_id":"6015b092-30b7-4e5f-aaa3-8bfa53d6e6f6"},{"name":"Delete Company Pricing","id":"ea8b35dd-8d10-40fd-9c9f-16cc45d5f051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to delete pricing for an existing company. The company can be identified by it's lookup key.

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"d4c6ed1f-c90b-4102-b83c-bb1716bac320","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"9482","key":"lookupValue"}]}},"response":[{"id":"65c23490-63bc-46dc-9b70-08f562c9948b","name":"Delete Company Pricing - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"key":"lookupValue","value":"122586","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"197"},{"key":"date","value":"Wed, 20 Apr 2022 15:41:31 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"2fb9ab1b-d503-41ee-8aeb-4a00acd52df8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent resource [Company] with id [122589] not found\"\n ],\n \"status\": 404,\n \"code\": 40007,\n \"type\": \"ParentCompanyNotFound\"\n }\n}"},{"id":"5c2dba18-16e5-419d-867d-aa18965d978c","name":"Delete Company Pricing - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Mon, 22 May 2023 16:26:44 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"121cfbf7-1b14-4b39-9c64-77b287c03cce"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"}],"_postman_id":"ea8b35dd-8d10-40fd-9c9f-16cc45d5f051"}],"id":"92633dd7-7a46-4ba3-8bc6-61d47f542393","description":"

The Company Pricing endpoints can be used to manage pricing for companies. Read more about pricing to learn more details.

\n","_postman_id":"92633dd7-7a46-4ba3-8bc6-61d47f542393","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Create Company","id":"210b7b4d-564b-4364-a3a3-1a7a00df8ee7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 209\r\n },\r\n \"name\": \"Propeller B.V.\",\r\n \"taxNumber\": \"NL860325386B01\",\r\n \"cocNumber\": \"75564998\",\r\n \"notes\": \"Company created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/","description":"

Use this endpoint to create a single company. If a company is successfully created, the response will include the usergroup id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
name	no
language	no
parent	no
taxNumber	no
cocNumber	no
department	no
office	no
notes	no
inheritProductList	no Default is `Y`
inheritOrderList	no Default is `Y`
budget	no Default is `N`
budgetInherit	no Default is `Y`
orderListAllowAll	no Default is `U`
sourceId	no
source	only when sourceId is provided

Use this endpoint to retrieve company details by lookup key. If multiple companies with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the company (e.g. source and language for lookup key sourceId).

Use expands as a query parameter to fetch additional information for companies like sources, etc.

sources: if the expands parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the sources property in the response will be just an empty array.\nparent: use this value in the expands query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a company can be a resource of type usergroup

\n","type":"text/plain"},"key":"expands","value":"sources"}],"variable":[{"description":{"content":"

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"151","key":"lookupValue"}]}},"response":[{"id":"6ceb7310-a6f7-4ced-913d-281a0f060ddc","name":"GET Company by lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"151","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"386"},{"key":"date","value":"Mon, 22 May 2023 15:15:15 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"cdcf6014-c7f3-476f-a9c6-71c978c2e5ec"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"inheritOrderList\": \"N\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"Company created from API\",\n \"taxNumber\": \"NL860325386B01\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"75564998\",\n \"id\": 151,\n \"name\": \"Propeller B.V.\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"f054698c-379e-4507-a63a-13a0fe5f1ff2","name":"GET Company by lookup key - 200 (expand: sources)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue?expands=sources","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"sources","description":"Use `expands` as a query parameter to fetch additional information for companies like sources, etc.\n`sources`: if the `expands` parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a company can be a resource of type `usergroup`"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"399"},{"key":"date","value":"Mon, 22 May 2023 15:16:44 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b6c22f97-93ed-4b6d-a7cf-8a56a8bc4c1f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"userManagerId\": \"\",\n \"sources\": [],\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"inheritOrderList\": \"N\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"Company created from API\",\n \"taxNumber\": \"NL860325386B01\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"75564998\",\n \"id\": 151,\n \"name\": \"Propeller B.V.\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"e16dc95e-6c36-42b1-adfc-3008ea9c0778","name":"GET Company by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9483","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"165"},{"key":"date","value":"Mon, 22 May 2023 15:18:11 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"90dff1a1-c30e-4848-aee6-2b7c63210802"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40006\",\n \"messages\": [\n \"Company with id [9483] not found\"\n ],\n \"status\": 404,\n \"code\": 40006,\n \"type\": \"CompanyNotFound\"\n }\n}"},{"id":"dd19e57e-885f-4fa3-8bd6-9c3213272736","name":"GET Company by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9483","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Mon, 22 May 2023 15:19:02 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"140fb9e3-3b63-40ba-87ce-24eb5f43d78e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"55029eb5-860b-4271-a618-b3f5d194ac34"},{"name":"Update Company by lookup key","id":"43ebd74a-4acb-4063-9c9e-fa3cde0cb8af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 106\r\n },\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3000000,\r\n \"name\": \"Propellor B.V.\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"taxNumber\": \"NL860325386B01\",\r\n \"cocNumber\": \"75564998\",\r\n \"notes\": \"Company created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","description":"

Use this endpoint to update company by lookup key. If multiple companies with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the company (e.g. source and language for lookup key sourceId).

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"151","key":"lookupValue"}]}},"response":[{"id":"3653c0a4-f631-4f05-a861-e0ee34cb4c10","name":"Update Company by lookup key - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 106\r\n },\r\n \"name\": \"Propellor B.V.\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"taxNumber\": \"NL860325386B01\",\r\n \"cocNumber\": \"75564998\",\r\n \"notes\": \"Company created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"303"},{"key":"date","value":"Mon, 22 May 2023 15:23:24 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"032d03c1-4699-4316-b567-f0e65bb962a0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"parent\": {\n \"id\": 106\n },\n \"name\": \"Propellor B.V.\",\n \"department\": \"\",\n \"office\": \"\",\n \"taxNumber\": \"NL860325386B01\",\n \"cocNumber\": \"75564998\",\n \"notes\": \"Company created from API\",\n \"inheritProductList\": \"Y\",\n \"inheritOrderList\": \"N\",\n \"budget\": \"N\",\n \"budgetInherit\": \"N\",\n \"id\": 9482\n },\n \"messages\": [\n \"Company updated\"\n ],\n \"total\": 1\n}"},{"id":"45d8d958-7809-475a-abfd-8d1d7e8aa2e9","name":"Update Company by lookup key - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 106\r\n },\r\n \"name\": \"Propellor B.V.\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"taxNumber\": \"NL860325386B01\",\r\n \"cocNumber\": \"75564998\",\r\n \"notes\": \"Company created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9484","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"165"},{"key":"date","value":"Mon, 22 May 2023 15:24:56 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"093d51a4-4d04-4743-8345-5b4cade4fefc"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40006\",\n \"messages\": [\n \"Company with id [9484] not found\"\n ],\n \"status\": 404,\n \"code\": 40006,\n \"type\": \"CompanyNotFound\"\n }\n}"},{"id":"a89cb931-b2b6-4b17-8680-4452ab99aef5","name":"Update Company by lookup key - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 106\r\n },\r\n \"name\": \"Propellor B.V.\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"company\": \"Propellor B.V.\",\r\n \"taxNumber\": \"NL860325386B01\",\r\n \"cocNumber\": \"75564998\",\r\n \"notes\": \"Company created from API\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9482","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Mon, 22 May 2023 15:24:07 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"8a5757bf-03e6-4d19-bbe2-f9e32884d18a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [company] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"43ebd74a-4acb-4063-9c9e-fa3cde0cb8af"},{"name":"Delete Company by lookup key","id":"bf590701-fbe5-4e44-9962-9e90d9b85d0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","description":"

Delete a company by a specific lookupKey / lookupId combination. A deleted company will be moved to the Propeller Recycle bin. This means the deleted company can be restored, however, only via the Propeller backoffice.

Lookup key. Read more about company lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"be1b7838-80ee-46db-9950-6edbe2ac4c99","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"646","key":"lookupValue"}]}},"response":[{"id":"17d2d112-e15e-4acb-b1db-181f35a9594b","name":"Delete Company by lookup key - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"646","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Mon, 22 May 2023 15:26:43 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c038ed9b-1b4f-41ce-bcca-c855c241694b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Company deleted\"\n ]\n}"},{"id":"cc007cba-52dc-4aa6-a862-156c92b4bff0","name":"Delete Company by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"298","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Mon, 22 May 2023 15:27:44 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"ebe85a54-4572-4e28-9d69-9ccb8060d13c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"},{"id":"5b44d8c7-4481-4b1a-9df0-c589cab987f3","name":"Delete Company by lookup key - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/companies/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["companies",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"key":"lookupValue","value":"9483","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"171"},{"key":"date","value":"Mon, 22 May 2023 15:28:53 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"f71ae4cc-5c86-42e1-9d1c-1da8171e1a26"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/40006\",\n \"messages\": [\n \"Company with sourceId [9483] not found\"\n ],\n \"status\": 404,\n \"code\": 40006,\n \"type\": \"CompanyNotFound\"\n }\n}"}],"_postman_id":"bf590701-fbe5-4e44-9962-9e90d9b85d0d"},{"name":"Bulk Companies by source id","id":"bafa3477-6688-4fa3-82dd-f81612ecfd7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"companies\": [\r\n {\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 200001,\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"sourceId\": 100000\r\n },\r\n \"name\": \"Propeller B.V.\",\r\n \"taxNumber\": \"NL860325386B01\",\r\n \"cocNumber\": \"75564998\",\r\n \"notes\": \"Company created from API\",\r\n \"department\": \"\",\r\n \"office\": \"\",\r\n \"inheritProductList\": \"Y\",\r\n \"inheritOrderList\": \"N\",\r\n \"budget\": \"N\",\r\n \"budgetInherit\": \"N\"\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipMoveOnUpdate\",\r\n \"fields\": []\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/bulk/sourceId","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of companies with just a single API call. When using the bulk sourceId endpoint, the companies are identified by sourceId, source and language. If a company doesn't already exist, it will be created. If it does exist, the company found will be updated.

Company bulk endpoints support bulk change of attributes for multiple companies as well. To learn more about Attributes, go here.

Company bulk endpoints support bulk change of pricing for multiple companies as well. To learn more about Pricing, go here.

A single company's attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple companies in a single call, this endpoint should be used.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
companies (array of company objects)	yes
source	yes
sourceId	yes
name	no
language	yes
parent	no
taxNumber	no
cocNumber	no
department	no
office	no
notes	no
inheritProductList	no Default is `Y`
inheritOrderList	no Default is `Y`
budget	no Default is `N`
budgetInherit	no Default is `Y`
orderListAllowAll	no Default is `U`
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing company that are not empty	array of field names e.g. name, office etc.
skipMoveOnUpdate	On update, skip moving an existing company in the parent provided	empty array

What are directives?

The bulk endpoints offer an efficient way of importing/updating large amounts of companies with just a single API call. When using the bulk id endpoint, the companies are identified by id. If a company with such id doesn't already exist, it will be created. If it does exist, the company found will be updated.

Company bulk endpoints support bulk change of attributes for multiple companies as well. To learn more about Attributes, go here.

Company bulk endpoints support bulk change of pricing for multiple companies as well. To learn more about Pricing, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
companies (array of company objects)	yes
id	yes
name	no
language	no
parent	no
taxNumber	no
cocNumber	no
department	no
office	no
notes	no
inheritProductList	no Default is `Y`
inheritOrderList	no Default is `Y`
budget	no Default is `N`
budgetInherit	no Default is `Y`
orderListAllowAll	no Default is `U`
sourceId	no
source	only when sourceId is provided
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing company that are not empty	array of field names e.g. name, office etc.
skipMoveOnUpdate	On update, skip moving an existing company in the parent provided	empty array

What are directives?

\n
The companies search endpoint is only available on the Propeller cloud version.
\n

Retrieves a list of companies by using the search fields below. Results will be paginated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
dateCreated	DateFilter
dateModified	DateFilter
offset	integer
page	integer

Date filter

A date filter is a special date search object that can search through a range:

{\n    \"from\": \"2020-12-12T00:00:00\",\n    \"to\": \"2022-12-12T00:00:00\"\n}\n\n

Use expands as a query parameter to fetch additional information for companies like sources, parent, etc.\nsources: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the sources property in the response will be just an empty array.

\n","type":"text/plain"},"key":"expands","value":"sources"}],"variable":[]}},"response":[{"id":"df037082-84f1-47fc-be1a-0ffaba7b62cf","name":"Search Companies - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"dateCreated\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 516\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"3260"},{"key":"date","value":"Thu, 31 Aug 2023 11:35:34 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"67338ba0-55ee-4a7b-847d-acf1f3c90a60"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-19T11:46:20\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"taxNumber\": \"123456\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-05-19T11:46:20\",\n \"id\": 9478,\n \"name\": \"Comapny 1\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-19T11:54:55\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"taxNumber\": \"123456\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-05-19T11:54:55\",\n \"id\": 9479,\n \"name\": \"Company 2\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-19T13:38:00\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"taxNumber\": \"123456\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-05-19T13:38:00\",\n \"id\": 9481,\n \"name\": \"Company 3\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-23T09:57:24\",\n \"inheritOrderList\": \"N\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"Company created from API\",\n \"taxNumber\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"N\",\n \"cocNumber\": \"75564998\",\n \"dateCreated\": \"2023-05-22T15:11:46\",\n \"id\": 9482,\n \"name\": \"Propellor Company\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 944644\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-22T15:39:12\",\n \"inheritOrderList\": \"N\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"Company created from API\",\n \"taxNumber\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"75564998\",\n \"dateCreated\": \"2023-05-22T15:39:13\",\n \"id\": 9483,\n \"name\": \"Propeller Nr.2\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-26T16:33:19\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"taxNumber\": \"123456\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-05-26T16:32:55\",\n \"id\": 9484,\n \"name\": \"Company 4\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-26T16:45:45\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"taxNumber\": \"123456\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-05-26T16:45:45\",\n \"id\": 9485,\n \"name\": \"Company 5\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n },\n {\n \"userManagerId\": \"\",\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"dateModified\": \"2023-05-26T16:54:34\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"taxNumber\": \"123456\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"cocNumber\": \"\",\n \"dateCreated\": \"2023-05-26T16:53:28\",\n \"id\": 9486,\n \"name\": \"Company 6\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": \"\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 6181,\n \"pages\": 516,\n \"total\": 8,\n \"offset\": 12,\n \"itemsFound\": 6188,\n \"end\": 6188,\n \"page\": 516\n}"},{"id":"7de08563-12bf-4592-b23c-f72acd5a666d","name":"Search Companies - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sander\",\r\n \"dateCreated\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/companies/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 22 Aug 2023 08:28:02 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"9e835215-24c1-4a99-99b4-b1f808ec3215"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"dd2694b5-f201-4162-94d1-cc812b774aeb"}],"id":"8d75dc92-ae1b-434b-8c53-e63f433e66f7","description":"

Companies are used to group contacts from the same company together. This parent - child relationship i.e. tree organizational structure is very powerful because it allows inheriting addresses, settings, permissions, pricing, etc. A usergroup was used to represent a company in a B2B environment, but that concept will soon be deprecated and a dedicated Companies resource should be used. Usergroups can still be used to group Companies.

\n
The company API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API
\n

Company Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller `company` id
sourceId	string	External system unique id. sourceId should be combined with source

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
name	Company name	string
language	Default system language	string ISO 639-1
parent	Parent usergroup	JSON object that identifies the parent. `id` or `sourceId` in combination with `source`
taxNumber	Company tax number	string
cocNumber	Chamber of commerce number	string
department	Department	string
office	Office	string
notes	Notes	string
inheritProductList	Indicates whether pricing should be inherited from parent usergroup	enum `Y` = Yes `N` = No
inheritOrderList	Indicates whether the order list should be inherited from the parent usergroup	enum `Y` = Yes `N` = No
budget	Company budget settings	enum `Y` = Contacts in the company use budget and may only order products within budget `H` = Contacts in the company use budget and may also order products outside budget `N` = Contacts in the company do not use budgets
budgetInherit	Indicates whether budget settings should be inherited from parent usergroup	enum `Y` = Yes `N` = No
orderListAllowAll	Order list settings	enum `N` = Order everything within the order list `Y` = Order everything outside the order list `A` = Order everything, but products outside the order list must be authorized `U` = Order everything `P` = Order restricted products
sourceId	External system unique id	string
source	External system	string

Company Errors

This section describes error codes specific for the Company resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
40004	CompanyExists	400	Company already exists	Company with such lookup key already exists
40005	CompanyMultipleFound	400	Multiple companies found. Please provide additional filters	Multiple companies with such lookup key exist
40006	CompanyNotFound	404	Company does not exist	Company with such lookup key not found
40007	ParentCompanyNotFound	404	Parent company not found	Parent company with such lookup key not found. This error is typical when working with company sub-resources (e.g. attributes, addresses)
40008	CompanyNotAllowed	405	Company is not allowed	Usually when company is in Recycle Bin and can't be used
90006	AddressNotFound	404	Address does not exist	Company address does not exist

","_postman_id":"8d75dc92-ae1b-434b-8c53-e63f433e66f7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Contacts","item":[{"name":"Pricing","item":[{"name":"Create Contact Pricing","id":"bea1f2ba-5f10-4915-bbdb-b61fe6415078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to define pricing for an existing contact. The contact can be identified by it's lookup key. It is required to provide either categories or products or both in the payload.

Use cases

A common use case for this endpoint is when you want to give discounts only for a specific contact of the company.

If you want to give a discount of 20% of sales price on all products in a given category you can use the SP type pricing for a category. The contact will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for a single contact.

Lookup key. Read more about contact lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"54457f43-b41a-4f2f-b76b-50341793d2af","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25492","key":"lookupValue"}]}},"response":[{"id":"1638d038-9400-4c2d-9521-43a8a853d237","name":"Create Contact Pricing - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25492","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"238"},{"key":"date","value":"Tue, 23 May 2023 10:17:12 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b1b5eb83-c843-4ced-af33-d4b9f7636afe"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": 1797,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 77138,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 86011,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 3\n}"},{"id":"484ced59-51ed-43f8-9a0b-1fa57a9c62d0","name":"Create Contact Pricing - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 23 May 2023 10:17:39 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c3d43e11-9e16-4a65-be21-ec8fb27b95e0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [Contact] with id [25494] not found\"\n ],\n \"status\": 404,\n \"code\": 50007,\n \"type\": \"ParentContactNotFound\"\n }\n}"}],"_postman_id":"bea1f2ba-5f10-4915-bbdb-b61fe6415078"},{"name":"Delete Contact Pricing","id":"8eb7a14b-26ed-40c8-b9fb-fd45718cf762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to delete pricing for an existing contact. The contact can be identified by it's lookup key.

Lookup key. Read more about contact lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"2c489fc8-4a99-42e5-a0ce-3c759afd57e3","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25492","key":"lookupValue"}]}},"response":[{"id":"ea292f99-e7a8-44be-bd22-40340ea213b5","name":"Delete Contact Pricing - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25492","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Tue, 23 May 2023 10:19:02 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"d012a8fc-9cfd-4cf3-837f-76e2e57e3d5e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"},{"id":"f532c777-ade7-4f28-90c5-0687fd2a8c53","name":"Delete Contact Pricing - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 23 May 2023 10:19:26 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"98f5a9e3-22fb-4aa9-b5f4-c6d55792f74c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [Contact] with id [25494] not found\"\n ],\n \"status\": 404,\n \"code\": 50007,\n \"type\": \"ParentContactNotFound\"\n }\n}"}],"_postman_id":"8eb7a14b-26ed-40c8-b9fb-fd45718cf762"}],"id":"de45b52b-979b-471f-a9be-54e7788e6560","description":"

The Contact Pricing endpoints can be used to manage pricing for contacts. Read more about pricing to learn more details.

\n","_postman_id":"de45b52b-979b-471f-a9be-54e7788e6560","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Create Contact","id":"829c73c1-e54d-45b2-bfad-df0a9f6f92a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 9482\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"login\": \"miles@propel.us\",\r\n \"primaryLanguage\": \"EN\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/contacts/","description":"

Use this endpoint to create a single contact. If a contact is successfully created, the response will include the user id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
debtorId	no
firstName	no
middleName	no
lastName	no
fullName	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
parent	no
pricelistAmount	no
pricelistPercentage	no
primaryLanguage	no
ssn	no
sourceId	no
source	only when `sourceId` is provided

Use this endpoint to retrieve contact details by lookup key. If multiple contacts with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the contact (e.g. source and language for lookup key sourceId).

Use expands as a query parameter to fetch additional information for contacts like sources, parent, etc.

\n","type":"text/plain"},"key":"expands","value":"sources,parent"}],"variable":[{"id":"7ef6f54c-f554-427f-9ac1-32f6ec2422b8","description":{"content":"

Lookup key. Read more about contact lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"e296b3f3-3782-4f5c-9a21-c4294dae5953","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25492","key":"lookupValue"}]}},"response":[{"id":"6cb36f97-afba-4649-9ceb-ad4017ffa4bc","name":"GET Contact by lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25492","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"418"},{"key":"date","value":"Tue, 23 May 2023 09:36:07 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"02e3ff14-8d08-4a95-9b95-45a6a4d63063"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ssn\": \"\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Miles McCoy\",\n \"firstName\": \"Miles\",\n \"id\": 25492,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"2a01475e-65d7-4a74-b5e8-cdbd2b3fbf8d","name":"GET Contact by lookup key - 200 (expands: sources,parent)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue?expands=sources,parent","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"sources,parent","description":"Use `expands` as a query parameter to fetch additional information for contacts like sources, parent, etc.\n\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a contact can be a resource of type `company`"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25492","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"866"},{"key":"date","value":"Tue, 23 May 2023 09:35:09 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c1bf4dfd-e7fb-4ce6-9a1c-d0788cc53971"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ssn\": \"\",\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"3002196\"\n }\n ],\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Miles McCoy\",\n \"firstName\": \"Miles\",\n \"id\": 25492,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"parent\": {\n \"userManagerId\": \"\",\n \"sources\": [],\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"\",\n \"inheritOrderList\": \"N\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"Usergroup created from API\",\n \"taxNumber\": \"NL860325386B01\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"N\",\n \"cocNumber\": \"75564998\",\n \"id\": 9482,\n \"name\": \"Propeller B.V.\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 944644\n },\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"518bb098-1461-450c-a1a9-fb6687decd10","name":"GET Contact by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25493","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Tue, 23 May 2023 09:36:29 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"f066cdf7-3297-40e7-8098-0d13ae0bf9d7"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/50006\",\n \"messages\": [\n \"Contact with id [25493] not found\"\n ],\n \"status\": 404,\n \"code\": 50006,\n \"type\": \"ContactNotFound\"\n }\n}"},{"id":"bc9b2277-69e7-4c4d-ae21-8b9adaf6def1","name":"GET Contact by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25492","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Tue, 23 May 2023 09:37:07 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"17d9f411-a8f1-4293-873c-db345aa644ec"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"aa134c4e-ab57-4aa1-916c-283746c75e63"},{"name":"Update Contact by lookup key","id":"acd6779d-f857-4df9-bd0d-aec1ac1db8ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 9482\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","description":"

Use this endpoint to update contact by lookup key. If multiple contacts with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the contact (e.g. source and language for lookup key sourceId).

Lookup key. Read more about contact lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"cc406994-6b2f-47b6-a4f7-ec7982c7a4e4","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25492","key":"lookupValue"}]}},"response":[{"id":"a8904c78-54b7-4364-b73f-24f1f58debf0","name":"Update Contact by lookup key - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 9482\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25492","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"359"},{"key":"date","value":"Tue, 23 May 2023 09:40:37 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"264605d0-dd65-41a2-9d1d-1e95b88fd0fe"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"parent\": {\n \"id\": 9482\n },\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"abbreviation\": \"MM\",\n \"debtorId\": 12345,\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"dateOfBirth\": \"28/08/1993\",\n \"title\": \"Mr.\",\n \"gender\": \"M\",\n \"primaryLanguage\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": 3002196,\n \"id\": 25492\n },\n \"messages\": [\n \"Contact updated\"\n ],\n \"total\": 1\n}"},{"id":"ca16be43-04d7-4a80-92cf-145848f730a5","name":"Update Contact by lookup key - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 9482\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25493","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Tue, 23 May 2023 09:41:19 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c4db7bd1-a3ae-4625-8a05-4690650befea"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/50006\",\n \"messages\": [\n \"Contact with id [25493] not found\"\n ],\n \"status\": 404,\n \"code\": 50006,\n \"type\": \"ContactNotFound\"\n }\n}"},{"id":"7500bf4e-77f8-4b37-a1ee-e88dd605d7cd","name":"Update Contact by lookup key - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 9482\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"company\": \"Propeller\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25492","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Tue, 23 May 2023 09:41:57 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"20ded3dd-be0f-4cca-a4e5-1c30109b8404"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [company] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"acd6779d-f857-4df9-bd0d-aec1ac1db8ed"},{"name":"Delete Contact by lookup key","id":"8c3cdbdc-1c42-47be-a331-f5e76b642783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","description":"

Delete a contact by a specific lookupKey / lookupId combination. A deleted contact will be moved to the Propeller Recycle bin. This means the deleted contact can be restored, however, only via the Propeller backoffice.

Lookup key. Read more about contact lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"2f86f32e-1701-42a5-bba5-2d89dbc15ec8","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25493","key":"lookupValue"}]}},"response":[{"id":"5a0fc4d4-7c99-4354-8eb0-6f7e67cad583","name":"Delete Contact by lookup key - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25493","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Tue, 23 May 2023 09:45:16 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"15e7d72b-dfa1-4ae4-ba98-2018e9c41bac"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Contact deleted\"\n ]\n}"},{"id":"3d57676d-ae45-4f81-b87e-9cff191922fe","name":"Delete Contact by lookup key - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"172"},{"key":"date","value":"Tue, 23 May 2023 09:45:34 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"10475e20-5e05-4712-8c31-90cdc149d7b2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/50006\",\n \"messages\": [\n \"Contact with sourceId [25494] not found\"\n ],\n \"status\": 404,\n \"code\": 50006,\n \"type\": \"ContactNotFound\"\n }\n}"},{"id":"acf4ed4b-2af1-4f14-ab2c-2b68a9c89f88","name":"Delete Contact by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/contacts/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["contacts",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"key":"lookupValue","value":"25493","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Tue, 23 May 2023 09:45:54 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"284f7a22-14ec-4118-b4ac-5d112afee0fb"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"8c3cdbdc-1c42-47be-a331-f5e76b642783"},{"name":"Bulk Contacts by source id","id":"83a73896-ed2f-422d-a4e8-3a0d5d20ec1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts\": [\r\n {\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196,\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3000000\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0032445888\",\r\n \"phone\": \"0032445888\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"EN\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"SHOW_ONACCOUNT\" ,\r\n \"class\": \"user\",\r\n \"type\": \"enum\",\r\n \"value\": \"N\"\r\n },\r\n {\r\n \"name\": \"SHOW_PAYPAL\" ,\r\n \"class\": \"user\",\r\n \"type\": \"enum\",\r\n \"value\": \"Y\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/contacts/bulk/sourceId","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk sourceId endpoint, the contacts are identified by sourceId, source and language. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.

Contact bulk endpoints support bulk change of contact attributes for multiple contacts as well. To learn more about Attributes, go here.

Contact bulk endpoints support bulk change of pricing for multiple contacts as well. To learn more about Pricing, go here.

A single contacts attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple contacts, this endpoint should be used.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
contacts (array of contact objects)	yes
source	yes
sourceId	yes
debtorId	no
firstName	no
middleName	no
lastName	no
abbreviation	no
title	no
dateOfBirth	no
gender	no
ssn	no
phone	no
email	no
parent	no
pricelistAmount	no
pricelistPercentage	no
primaryLanguage	no
attributes Read more about attributes	no
pricing Read more about pricing	no

The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk id endpoint, the contacts are identified by id. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.

Contact bulk endpoints support bulk change of contact attributes for multiple contacts as well. To learn more about Attributes, go here.

Contact bulk endpoints support bulk change of pricing for multiple contacts as well. To learn more about Pricing, go here.

A single contact attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple contacts, this endpoint should be used.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
contacts (array of contact objects)	yes
id	yes
debtorId	no
firstName	no
middleName	no
lastName	no
abbreviation	no
title	no
dateOfBirth	no
gender	no
ssn	no
phone	no
email	no
parent	no
pricelistAmount	no
pricelistPercentage	no
primaryLanguage	no
sourceId	no
source	only when sourceId is provided
attributes Read more about attributes	no
pricing Read more about pricing	no

\n
The contacts search endpoint is only available on the Propeller cloud version.
\n

Retrieves a list of contacts by using the search fields below. Results will be paginated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
debtorIds	array(string)
dateCreated	DateFilter
dateModified	DateFilter
offset	integer
page	integer

Date filter

A date filter is a special date search object that can search through a range:

{\n    \"from\": \"2020-12-12T00:00:00\",\n    \"to\": \"2022-12-12T00:00:00\"\n}\n\n

Use expands as a query parameter to fetch additional information for contacts like sources, parent, etc.\nsources: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the sources property in the response will be just an empty array.

\n","type":"text/plain"},"key":"expands","value":"sources"}],"variable":[]}},"response":[{"id":"4b2ac5b9-2a08-436e-bdb8-a86bdf73728f","name":"Search Contacts - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"debtorIds\": [\"12345\",\"9943212\"],\r\n \"dateCreated\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/contacts/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1025"},{"key":"date","value":"Wed, 30 Aug 2023 10:36:56 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e19249c6-3532-497a-b1e0-6957946f2138"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ssn\": \"\",\n \"dateModified\": \"2023-05-23T10:14:24\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0032445888\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"dateCreated\": \"2023-05-23T09:28:32\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Miles McCoy\",\n \"firstName\": \"Miles\",\n \"id\": 25492,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n {\n \"ssn\": \"\",\n \"dateModified\": \"2023-05-24T14:40:42\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"NL\",\n \"dateCreated\": \"2023-05-24T14:39:47\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Miles McCoy\",\n \"firstName\": \"Miles\",\n \"id\": 25496,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 1,\n \"total\": 2,\n \"offset\": 12,\n \"itemsFound\": 2,\n \"end\": 2,\n \"page\": 1\n}"},{"id":"78bc6822-3db6-4ed6-b93d-79b1f6bc71ef","name":"Search Contacts - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sander\",\r\n \"dateCreated\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/contacts/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 22 Aug 2023 08:24:46 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"d54c0c06-d1de-4363-8a7d-393a7a77d161"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"755d69b1-134b-44f3-8d00-57d8262dd4ac"}],"id":"513e421b-50fb-4d92-b7ca-b8688063e707","description":"

Contacts represent data about a specific customer. Carts, orders, attributes are associated with contacts.

In a B2B environment a contact is part of a company representing the organisation he/she is working for. Orders for the company, in a B2B environment, are placed by a specific contact.

\n
The contact API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API
\n

Contact Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller `contact` id
sourceId	string	External system unique id. sourceId should be combined with source

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
debtorId	A unique id representing the company of this contact. A debtorId can be automatically generated by Propellor	integer string
firstName	Contact first name	string
middleName	Contact middle name	string
lastName	Contact last name	string
abbreviation	Contact abbreviation	string
title	Contact title	string
dateOfBirth	Contact date of birth	date
gender	Contact gender	enum m=Male f=Female u=Undefined
ssn	Contact ssn	string
phone	Contact phone number	integer
email	A valid email address	string
parent	Parent company	JSON object that identifies the parent. `id` or `sourceId` in combination with source
pricelistAmount	A `pricesheet` code in case of special pricing agreements	string
pricelistPercentage	A `pricesheet` code in case of special pricing agreements	string
primaryLanguage	Contact primary language	ISO 639-1
sourceId	External system unique id	string
source	External system	string

User Errors

This section describes error codes specific for the User resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
50004	ContactExists	400	Contactalready exists	Contact with such lookup key already exists
50005	ContactMultipleFound	400	Multuple contacts found. Please provide additional filters	Multiple contacts with such lookup key exist
50006	ContactNotFound	404	Contactdoes not exist	Contact with such lookup key not found
50007	ParentContactNotFound	404	Parent contact not found	Parent contact with such lookup key not found. This error is typical when working with contact sub-resources (e.g. attributes)
50008	ContactNotAllowed	404	Contact is not allowed	Usually when contact is in Recycle Bin and can't be used

","_postman_id":"513e421b-50fb-4d92-b7ca-b8688063e707","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Customers","item":[{"name":"Addresses","item":[{"name":"Create Address","id":"ec7284aa-d47b-4780-8bea-58d3ef457cea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/","description":"

Use this endpoint to create an address for a customer. If the address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	no
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"a9b15388-8b81-45d2-9dd3-69992577d89a","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"}]}},"response":[{"id":"fa735f82-965f-468e-bcfc-8c75d41f7393","name":"Create Address - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"416"},{"key":"date","value":"Tue, 23 May 2023 12:01:33 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"02c92970-55a2-49bd-9f8b-612343228fba"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"delivery\",\n \"code\": \"11234\",\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"street\": \"Noordpad\",\n \"postalCode\": \"6822 DE\",\n \"city\": \"Arnhem\",\n \"icp\": \"N\",\n \"country\": \"NL\",\n \"region\": \"\",\n \"number\": \"34\",\n \"numberExtension\": \"A\",\n \"notes\": \"Address notes\",\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"url\": \"www.propel.us\",\n \"isDefault\": \"Y\",\n \"id\": 106099\n },\n \"messages\": [\n \"Address created\"\n ],\n \"total\": 1\n}"},{"id":"faff8501-1c87-4e5b-9a70-03d3f8aca756","name":"Create Address - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 23 May 2023 12:02:05 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"6b5273ca-1e15-4cbb-a4bd-f4e3d1adfaf1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60007\",\n \"messages\": [\n \"Parent resource [Customer] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60007,\n \"type\": \"ParentCustomerNotFound\"\n }\n}"},{"id":"61ff0569-c2f6-46bd-9587-0ed097bd87f3","name":"Create Address - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"U\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",""],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"183"},{"key":"date","value":"Tue, 23 May 2023 12:02:28 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"3716b59f-af0c-429d-ad5a-6368c3a1d7eb"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"ec7284aa-d47b-4780-8bea-58d3ef457cea"},{"name":"Get Customer Addresses by type","id":"aa4a157d-59a8-459f-b4fa-b6061189d2d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/?type=delivery","description":"

Use this endpoint to retrieve a list of all customer addresses. Addresses can be filtered by type.

Optional. Only retrieve a certain type of address. Possible values:

delivery\ninvoice\nhome

\n","type":"text/plain"},"key":"type","value":"delivery"}],"variable":[{"id":"4aa4d95a-2d3e-4f82-9a8c-44a508d4079c","description":{"content":"

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"bfd58978-cdb0-40b2-a02d-fddc8821a7e8","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"}]}},"response":[{"id":"687a2180-69f5-46e6-a005-aafc6c274b0f","name":"Get Customer Addresses by type - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice\nhome"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1315"},{"key":"date","value":"Tue, 23 May 2023 12:06:12 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"5dccfb6e-3282-4ef5-9a0b-6e40fbd1b0ff"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 106097,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"N\",\n \"email\": \"miles@propel.us\"\n },\n {\n \"postalCode\": \"1016 XA\",\n \"icp\": \"N\",\n \"company\": \"Propel\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"193\",\n \"street\": \"Lijnbaansgracht\",\n \"url\": \"www.propel.us\",\n \"code\": \"11235\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 106098,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Amsterdam\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"N\",\n \"email\": \"miles@propel.us\"\n },\n {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 106099,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"Y\",\n \"email\": \"miles@propel.us\"\n }\n ],\n \"messages\": [],\n \"total\": 3\n}"},{"id":"66dde90d-52b0-4b88-96d4-8533ad88c1ca","name":"Get Customer Addresses by type - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",""],"query":[{"key":"type","value":"delivery","description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice\nhome"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 23 May 2023 12:06:53 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"eb9e8d2a-60b5-4ff9-98e2-df8ca8f2222a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60007\",\n \"messages\": [\n \"Parent resource [Customer] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60007,\n \"type\": \"ParentCustomerNotFound\"\n }\n}"}],"_postman_id":"aa4a157d-59a8-459f-b4fa-b6061189d2d6"},{"name":"Get Address by id","id":"fdbdc222-edcc-4e9e-a6c4-d3e06f5445bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to retrieve details for a customer address. The address is identified by id.

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"a958879d-0773-4449-8c70-61593ad93062","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"},{"id":"14855d5f-46fd-4cca-9e3c-baebade0d0ac","description":{"content":"

id of the address

\n","type":"text/plain"},"type":"any","value":"106099","key":"addressId"}]}},"response":[{"id":"2d3e610a-917e-4514-ba66-db38292bdb20","name":"Get Address by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106099","description":"id of the address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"457"},{"key":"date","value":"Tue, 23 May 2023 12:08:18 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"7e072971-c489-4dde-b675-570fcd6a1ed2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"postalCode\": \"6822 DE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"Address notes\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"fax\": \"\",\n \"number\": \"34\",\n \"street\": \"Noordpad\",\n \"url\": \"www.propel.us\",\n \"code\": \"11234\",\n \"gender\": \"U\",\n \"firstName\": \"Miles\",\n \"name\": \"\",\n \"id\": 106099,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Arnhem\",\n \"phone\": \"0032445888\",\n \"numberExtension\": \"A\",\n \"isDefault\": \"Y\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"e81f0c73-abb8-4926-aacc-42a89fe99d23","name":"Get Address by id - 404 (customer)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106099","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 23 May 2023 12:08:45 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"6916b1ad-1583-4408-9f55-61b66065f254"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60007\",\n \"messages\": [\n \"Parent resource [Customer] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60007,\n \"type\": \"ParentCustomerNotFound\"\n }\n}"},{"id":"af1a6e88-0edd-4372-8db8-0ce5be83af3a","name":"Get Address by id - 404 (address)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106055","description":"id of the address"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"199"},{"key":"date","value":"Tue, 23 May 2023 12:09:10 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"382b91a4-7f89-47df-9b81-cf0892d2adc1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [106055] not found for [Customers] with id [25494]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"fdbdc222-edcc-4e9e-a6c4-d3e06f5445bb"},{"name":"Update Address","id":"4190c746-91a3-4843-93da-7d1abec1c3ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to update a customer address. The address is identified by id.

Lookup key. Read more about user lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"1bdd0013-5ea8-4095-bebe-db47603ef222","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"},{"id":"c8d05f6c-4c0d-42f6-a2e3-c02a803fdc79","description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"106099","key":"addressId"}]}},"response":[{"id":"aab5b876-84b6-43bc-b061-4a9bb4a12f1f","name":"Update Address - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106099","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"104"},{"key":"date","value":"Tue, 23 May 2023 12:38:55 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"bbbae33c-23d4-4194-9b4b-28effc897548"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"firstName\": \"Miles\",\n \"lastName\": \"McCoy\",\n \"id\": 106099\n },\n \"messages\": [\n \"Address updated\"\n ],\n \"total\": 1\n}"},{"id":"023611f3-9121-4706-a037-00938e57f189","name":"Update Address - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106099","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 23 May 2023 12:39:39 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c408859d-b14a-41f0-ac03-f759d97e1ac0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60007\",\n \"messages\": [\n \"Parent resource [Customer] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60007,\n \"type\": \"ParentCustomerNotFound\"\n }\n}"},{"id":"4764efea-4cf4-44d5-8285-834de8ce7ba2","name":"Update Address - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Miles\",\r\n \"lastName\": \"McCoy\",\r\n \"isDefault\": \"U\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106099","description":"Address id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"183"},{"key":"date","value":"Tue, 23 May 2023 12:40:43 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"801abe57-ebd3-4476-ba67-8b214b38db70"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/isDefault: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"4190c746-91a3-4843-93da-7d1abec1c3ed"},{"name":"Delete Address","id":"7fca539e-76e6-4a65-96e2-4c459f674a54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to delete a customer address. The address is identified by id.

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"96edd503-d1f0-4128-a301-af65cf760dc1","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"},{"id":"332b0bd9-2ff7-44cf-9eb4-7496cd731de8","description":{"content":"

Address id

\n","type":"text/plain"},"type":"any","value":"106098","key":"addressId"}]}},"response":[{"id":"bb386cbd-8d60-4c5b-983c-26af2154710a","name":"Delete Address - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106098","description":"Address id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Tue, 23 May 2023 12:43:54 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"146a579b-3111-41a7-9848-77256b920e7d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Address deleted\"\n ]\n}"},{"id":"cb2f2550-59b8-41bb-a76b-6b9f671b2d3e","name":"Delete Address - 404 (customer)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106100","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 23 May 2023 12:43:26 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"64ed8ed2-e1c2-40a1-ab47-fd5b224a123a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60007\",\n \"messages\": [\n \"Parent resource [Customer] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60007,\n \"type\": \"ParentCustomerNotFound\"\n }\n}"},{"id":"b44ddad4-f44a-4736-935d-5f7eeb612d40","name":"Delete Address - 404 (address)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"},{"key":"addressId","value":"106100","description":"Address id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"199"},{"key":"date","value":"Tue, 23 May 2023 12:43:06 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"2492b513-351e-4f4d-ae56-76727f50e9fd"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [106100] not found for [Customers] with id [25494]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"7fca539e-76e6-4a65-96e2-4c459f674a54"},{"name":"Bulk Addresses","id":"276bf6db-3e16-499d-9496-be0d6cd354b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/bulk","description":"

Use this endpoint to create multiple customer addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
code	yes
firstName	no
middleName	no
lastName	no
gender	no Default is `U`
street	yes
number	no
numberExtension	no
postalCode	no
city	yes
country	yes
region	no
icp	no Default is `N`
phone	no
mobile	no
email	no
company	no
url	no
isDefault	no Default is `N`
notes	no

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"729dc5a5-9d79-499c-8f73-c5cb0caa6686","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"}]}},"response":[{"id":"96dfa137-95e9-4e1c-960c-99a2ea4d7ae2","name":"Bulk Addresses - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses","bulk"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"207"},{"key":"date","value":"Tue, 23 May 2023 12:45:50 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"35b864a6-4eee-4056-9d7b-11db864e716f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": \"11234\",\n \"id\": 106097,\n \"action\": \"update\",\n \"lookupKey\": \"code\"\n },\n {\n \"success\": true,\n \"key\": \"11235\",\n \"id\": 106104,\n \"action\": \"create\",\n \"lookupKey\": \"code\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"65dcc0ab-dc55-4ec6-8729-3b63960aef8e","name":"Bulk Addresses - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses","bulk"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 23 May 2023 12:46:16 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"183c702b-44a3-4f37-a7bd-137fb22569fc"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60007\",\n \"messages\": [\n \"Parent resource [Customer] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60007,\n \"type\": \"ParentCustomerNotFound\"\n }\n}"},{"id":"f4023867-b443-4513-a3dd-cbe46bc41c82","name":"Bulk Addresses - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"U\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/addresses/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","addresses","bulk"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"189"},{"key":"date","value":"Tue, 23 May 2023 12:46:35 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"627ad968-9d2b-4ac8-abe1-57eae2867cd0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/addresses/0/icp: U is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"276bf6db-3e16-499d-9496-be0d6cd354b8"}],"id":"798d48c4-a086-4c88-b897-57139ca4a842","description":"

The Customer Addresses endpoints can be used to manage customer addresses. A customer can have multiple addresses of different type: delivery, invoice or home.

Fields

Name	Description	Type
type	Address type	enum delivery invoice home
code	Address code	string
firstName	First name	string
middleName	Middle name	string
lastName	Last name	string
gender	Gender	enum M=Male F=Female U=Undefined
street	Street	string
number	Number	string
numberExtension	Number extension	string
postalCode	Postal code	string
city	City	string
country	Country	string
region	Region	string
icp	Indicates whether tax should be calculated when goods are delivered at this address	enum Y = Yes N = No
phone	Phone number	string
mobile	Mobile number	string
email	A valid email address	string
company	Organization the address is located at (if any)	string
url	Website	string
isDefault	Is this address the default address for the user of the provided type?	enum Y = Yes N = No
notes	Helpful notes for locating the address, etc.	string

","_postman_id":"798d48c4-a086-4c88-b897-57139ca4a842","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Pricing","item":[{"name":"Create Customer Pricing","id":"a950a2eb-573d-4fbf-b46f-35972b4556e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to define pricing for an existing customer. The customer can be identified by it's lookup key. It is required to provide either categories or products or both in the payload.

Use cases

A common use case for this endpoint is when you want to give discounts only for a specific customer.

If you want to give a discount of 20% of sales price on all products in a given category you can use the SP type pricing for a category. The customer will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for a single customer.

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"2b82bdb9-96a1-4233-8205-2b8bc58c021f","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"}]}},"response":[{"id":"d37bc23e-1669-44df-a102-15d34b3dd6ff","name":"Create Customer Pricing - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"238"},{"key":"date","value":"Tue, 23 May 2023 12:49:32 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"652b583a-9d38-439e-9512-ba73976d4305"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": 1797,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 77138,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 86011,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 3\n}"},{"id":"e286144d-8ef6-4137-b00f-840eb29da52d","name":"Create Customer Pricing - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shopId\": 1,\r\n \"categories\": [\r\n {\r\n \"id\": 1797,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\"\r\n }\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 77138,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\"\r\n }\r\n },\r\n {\r\n \"id\": 86011,\r\n \"pricing\": {\r\n \"price\": 4\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 23 May 2023 12:49:52 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"d0d65f0f-a8fa-4deb-8215-f28ae00c6b72"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"a950a2eb-573d-4fbf-b46f-35972b4556e2"},{"name":"Delete Customer Pricing","id":"075c80da-478a-4cdb-acef-5ff1c8265e77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to delete pricing for an existing customer. The customer can be identified by it's lookup key.

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"6ee886b6-b8d5-485a-896c-1e2d1265d30f","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"}]}},"response":[{"id":"1c303bda-fd28-4f34-a299-c98dea61a6a6","name":"Delete User Pricing - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"14718","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Wed, 20 Apr 2022 15:29:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"0081d0da-5b74-4ff7-9099-b350fceb20bd"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"},{"id":"5f883ee2-5944-4f1f-9ef4-27c168362e5a","name":"Delete User Pricing - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/users/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["users",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"key":"lookupValue","value":"17486","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"186"},{"key":"date","value":"Wed, 20 Apr 2022 15:26:58 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"0259b0cd-14f1-4e4c-862e-96f54d5210a6"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [14699] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"},{"id":"19ebb290-5641-4d59-957e-1ae0b54273d4","name":"Delete Customer Pricing - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Tue, 23 May 2023 12:51:25 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e15dac3a-4e5f-4c80-958c-efa603817c73"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"},{"id":"16b53414-656f-4e56-b080-dc0bb24d4d98","name":"Delete Customer Pricing - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 23 May 2023 12:51:37 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c723ab28-9af0-4ad6-8b7f-f4c1dc517f65"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/70007\",\n \"messages\": [\n \"Parent resource [User] with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 70007,\n \"type\": \"ParentUserNotFound\"\n }\n}"}],"_postman_id":"075c80da-478a-4cdb-acef-5ff1c8265e77"}],"id":"11360fd2-4a22-4a2c-b0bf-bcd85f99e013","description":"

The Customer Pricing endpoints can be used to manage pricing for customers. Read more about pricing to learn more details.

\n","_postman_id":"11360fd2-4a22-4a2c-b0bf-bcd85f99e013","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Create Customer","id":"00088220-eb90-48c1-8d9c-4598048c40de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"id\": 109\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"login\": \"miles@propel.us\",\r\n \"primaryLanguage\": \"EN\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3004196\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/","description":"

Use this endpoint to create a single customer. If a customer is successfully created, the response will include the user id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
debtorId	no
firstName	no
middleName	no
lastName	no
abbreviation	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
ssn	no
parent	no
pricelistAmount	no
pricelistPercentage	no
primaryLanguage	no
sourceId	no
source	only when `sourceId` is provided

Use this endpoint to retrieve customer details by lookup key. If multiple customers with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the customer (e.g. source and language for lookup key sourceId).

Use expands as a query parameter to fetch additional information for customers like sources, parent, etc.

\n","type":"text/plain"},"key":"expands","value":"sources,parent"}],"variable":[{"id":"ce848330-c521-4b06-b7f3-8a09ad86dff2","description":{"content":"

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"1c3d6ff1-e79a-452b-ae68-59cfff20dc65","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"}]}},"response":[{"id":"f8225fec-d769-41bb-941f-6ad5db3251e4","name":"GET Customer by lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"418"},{"key":"date","value":"Tue, 23 May 2023 11:41:22 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"7471f125-775e-4eb8-be94-4784c87785b0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ssn\": \"\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Miles McCoy\",\n \"firstName\": \"Miles\",\n \"id\": 25494,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"15d600a9-b312-4033-9a68-2242d6afdcaa","name":"GET Customer by lookup key - 200 (expands: sources,parent)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue?expands=sources,parent","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"sources,parent","description":"Use `expands` as a query parameter to fetch additional information for customers like sources, parent, etc.\n\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a customer can be a resource of type `usergroup`"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"944"},{"key":"date","value":"Tue, 23 May 2023 11:40:17 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"495769da-c295-4300-b06a-6209896d4e56"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ssn\": \"\",\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"3004196\"\n }\n ],\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0038975648\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Miles McCoy\",\n \"firstName\": \"Miles\",\n \"id\": 25494,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"parent\": {\n \"userManagerId\": \"\",\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RCEB0451-3\",\n \"sourceId\": \"199605\"\n },\n {\n \"language\": \"NL\",\n \"source\": \"OTTEVANGER-TRIMERGO\",\n \"sourceId\": \"OTTEVANGER-TRIMERGO-CRM-ROOT\"\n }\n ],\n \"inheritProductList\": \"Y\",\n \"budget\": \"N\",\n \"company\": \"Trimergo\",\n \"inheritOrderList\": \"Y\",\n \"orderListAllowAll\": \"U\",\n \"notes\": \"\",\n \"orderListManagerId\": \"\",\n \"office\": \"\",\n \"department\": \"\",\n \"budgetInherit\": \"Y\",\n \"id\": 109,\n \"name\": \"Customer root\",\n \"authorizeId\": \"\",\n \"defaultobjectId\": 227298\n },\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"ae4f447b-d4b3-4497-b4dc-bc03a27678ab","name":"GET Customer by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25495","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"168"},{"key":"date","value":"Tue, 23 May 2023 11:41:42 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"3a97afbc-b68c-4630-928d-634a9bfabcf9"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60006\",\n \"messages\": [\n \"Customer with id [25495] not found\"\n ],\n \"status\": 404,\n \"code\": 60006,\n \"type\": \"CustomerNotFound\"\n }\n}"},{"id":"b94bce77-ae17-44d0-bff4-c83750383c50","name":"GET Customer by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25495","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Tue, 23 May 2023 11:41:56 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b13165aa-cd34-4d5e-b98a-13576faffc26"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"c72c6d88-be85-4599-8413-c9f85143b610"},{"name":"Update Customer by lookup key","id":"03f55e1c-ed9a-466b-9aea-8526800d47f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 109\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","description":"

Use this endpoint to update customer by lookup key. If multiple customers with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the customer (e.g. source and language for lookup key source).

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"d7602a4a-208d-438f-afcf-e0999121fb1f","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25494","key":"lookupValue"}]}},"response":[{"id":"70827676-7c97-4930-9d50-829f0c00186b","name":"Update Customer by lookup key - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 109\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"359"},{"key":"date","value":"Tue, 23 May 2023 11:45:08 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"760355b1-1ec2-421f-ac5c-a9fd61a17e2e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"parent\": {\n \"id\": 109\n },\n \"firstName\": \"Miles\",\n \"middleName\": \"\",\n \"lastName\": \"McCoy\",\n \"abbreviation\": \"MM\",\n \"debtorId\": 12345,\n \"email\": \"miles@propel.us\",\n \"mobile\": \"0038975648\",\n \"phone\": \"0032445888\",\n \"dateOfBirth\": \"28/08/1993\",\n \"title\": \"Mr.\",\n \"gender\": \"M\",\n \"primaryLanguage\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": 3002196,\n \"id\": 25494\n },\n \"messages\": [\n \"Customer updated\"\n ],\n \"total\": 1\n}"},{"id":"4cd0963f-bbef-4b52-b350-a411d1514b68","name":"Update Customer by lookup key - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 109\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"168"},{"key":"date","value":"Tue, 23 May 2023 11:45:24 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b7b1ce52-8d92-4702-90e4-9a25c957f5ef"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60006\",\n \"messages\": [\n \"Customer with id [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60006,\n \"type\": \"CustomerNotFound\"\n }\n}"},{"id":"0c7d18ab-9809-4ce0-aaab-c6866ff6966b","name":"Update Customer by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"parent\": {\r\n \"id\": 109\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"dateOfBirth\": \"28/08/1993\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"NL\",\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25494","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Tue, 23 May 2023 11:45:48 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"290bd3ef-cb21-4dc3-bd27-688dffa3cae7"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"03f55e1c-ed9a-466b-9aea-8526800d47f8"},{"name":"Delete Customer by lookup key","id":"2f748fa0-5575-412c-b3cc-d19f2ff84785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","description":"

Delete a customer by a specific lookupKey / lookupId combination. A deleted customer will be moved to the Propeller Recycle bin. This means the deleted customer can be restored, however, only via the Propeller backoffice.

Lookup key. Read more about customer lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"288a5f9a-274f-40ad-a407-16bafe950468","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"25495","key":"lookupValue"}]}},"response":[{"id":"6c9d0868-0c89-4dd8-bcd5-1d14df871287","name":"Delete Customer by lookup key - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25495","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"45"},{"key":"date","value":"Tue, 23 May 2023 11:47:27 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b9364c49-e0f6-4270-80a5-53f2b9d553f4"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Customer deleted\"\n ]\n}"},{"id":"d20f12c3-2b40-4891-bb97-94bee8f24088","name":"Delete Customer by lookup key - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"174"},{"key":"date","value":"Tue, 23 May 2023 11:47:44 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"eda29dbb-4b1a-4d55-aa29-62e97c8dd765"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/60006\",\n \"messages\": [\n \"Customer with sourceId [25496] not found\"\n ],\n \"status\": 404,\n \"code\": 60006,\n \"type\": \"CustomerNotFound\"\n }\n}"},{"id":"c8b0eec5-479c-415e-9c93-b4a449be5e9d","name":"Delete Customer by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/customers/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["customers",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"ids","description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"key":"lookupValue","value":"25496","description":"The value of the key (id or sourceId)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"220"},{"key":"date","value":"Tue, 23 May 2023 11:48:00 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a2d95d66-bb19-4d62-b071-81fd78f90682"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"}],"_postman_id":"2f748fa0-5575-412c-b3cc-d19f2ff84785"},{"name":"Bulk Customers by source id","id":"cbd917e0-2fd6-4847-9bd0-3ef94a8c3515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"customers\": [\r\n {\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": 3002196,\r\n \"language\": \"NL\",\r\n \"parent\": {\r\n \"source\": \"RCEB0451-3\",\r\n \"sourceId\": \"199605\"\r\n },\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"abbreviation\": \"MM\",\r\n \"debtorId\": 12345,\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0032445888\",\r\n \"phone\": \"0032445888\",\r\n \"title\": \"Mr.\",\r\n \"gender\": \"M\",\r\n \"primaryLanguage\": \"EN\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"SHOW_ONACCOUNT\" ,\r\n \"class\": \"user\",\r\n \"type\": \"enum\",\r\n \"value\": \"N\"\r\n },\r\n {\r\n \"name\": \"SHOW_PAYPAL\" ,\r\n \"class\": \"user\",\r\n \"type\": \"enum\",\r\n \"value\": \"Y\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11234\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Noordpad\",\r\n \"postalCode\": \"6822 DE\",\r\n \"city\": \"Arnhem\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"34\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"Address notes\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"Y\"\r\n },\r\n {\r\n \"type\": \"delivery\",\r\n \"code\": \"11235\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"McCoy\",\r\n \"street\": \"Lijnbaansgracht\",\r\n \"postalCode\": \"1016 XA\",\r\n \"city\": \"Amsterdam\",\r\n \"icp\": \"N\",\r\n \"country\": \"NL\",\r\n \"region\": \"\",\r\n \"number\": \"193\",\r\n \"numberExtension\": \"A\",\r\n \"notes\": \"\",\r\n \"email\": \"miles@propel.us\",\r\n \"mobile\": \"0038975648\",\r\n \"phone\": \"0032445888\",\r\n \"company\": \"Propel\",\r\n \"url\": \"www.propel.us\",\r\n \"isDefault\": \"N\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/bulk/sourceId","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of customers with just a single API call. When using the bulk sourceId endpoint, the customers are identified by sourceId, source and language. If a customer doesn't already exist, it will be created. If it does exist, the customer found will be updated.

Customer bulk endpoints support bulk change of customer attributes for multiple customers as well. To learn more about Attributes, go here.

Customer bulk endpoints support bulk change of pricing for multiple customers as well. To learn more about Pricing, go here.

A single customer attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple customers, this endpoint should be used.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
customers (array of customer objects)	yes
source	yes
sourceId	yes
debtorId	no
firstName	no
middleName	no
lastName	no
abbreviation	no
title	no
dateOfBirth	no
gender	no
ssn	no
phone	no
email	no
parent	no
pricelistAmount	no
pricelistPercentage	no
primaryLanguage	no
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

The bulk endpoints offer an efficient way of importing/updating large amounts of customers with just a single API call. When using the bulk id endpoint, the customers are identified by id. If a customer doesn't already exist, it will be created. If it does exist, the customer found will be updated.

Customer bulk endpoints support bulk change of customer attributes for multiple customers as well. To learn more about Attributes, go here.

Customer bulk endpoints support bulk change of pricing for multiple customers as well. To learn more about Pricing, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
customers (array of customer objects)	yes
id	yes
debtorId	no
firstName	no
middleName	no
lastName	no
abbreviation	no
title	no
dateOfBirth	no
gender	no
ssn	no
phone	no
email	no
parent	no
pricelistAmount	no
pricelistPercentage	no
primaryLanguage	no
sourceId	no
source	only when sourceId is provided
attributes Read more about attributes	no
pricing Read more about pricing	no
addresses Read more about addresses	no

\n
The customers search endpoint is only available on the Propeller cloud version.
\n

Retrieves a list of customers by using the search fields below. Results will be paginated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
debtorIds	array(string)
dateCreated	DateFilter
dateModified	DateFilter
offset	integer
page	integer

Date filter

A date filter is a special date search object that can search through a range:

{\n    \"from\": \"2020-12-12T00:00:00\",\n    \"to\": \"2022-12-12T00:00:00\"\n}\n\n

Use expands as a query parameter to fetch additional information for customers like sources, parent, etc.\nsources: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the sources property in the response will be just an empty array.

\n","type":"text/plain"},"key":"expands","value":"sources"}],"variable":[]}},"response":[{"id":"ac514bb5-37c7-49c7-94af-6d6a839ded76","name":"Search Customers - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"debtorIds\": [\"12345\"],\r\n \"dateCreated\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2023-01-01T00:00:00\",\r\n \"to\": \"2023-12-31T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1043"},{"key":"date","value":"Thu, 31 Aug 2023 11:22:29 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e2ae5f24-40b6-46c0-a2c9-221fe16cdfe4"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ssn\": \"\",\n \"dateModified\": \"2023-05-23T11:54:56\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"McCoy\",\n \"mobile\": \"0032445888\",\n \"abbreviation\": \"MM\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"dateCreated\": \"2023-05-23T11:35:59\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Miles McCoy\",\n \"firstName\": \"Miles\",\n \"id\": 25494,\n \"middleName\": \"\",\n \"login\": \"miles@propel.us\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"miles@propel.us\"\n },\n {\n \"ssn\": \"\",\n \"dateModified\": \"2023-08-31T13:22:19\",\n \"pricelistPercentage\": \"\",\n \"debtorId\": \"12345\",\n \"lastName\": \"Vleugelhof\",\n \"mobile\": \"0032445888\",\n \"abbreviation\": \"SV\",\n \"fax\": \"\",\n \"pricelistAmount\": \"\",\n \"primaryLanguage\": \"EN\",\n \"dateCreated\": \"2023-06-07T13:40:40\",\n \"dateOfBirth\": \"August, 28 1993 00:00:00 +0000\",\n \"gender\": \"M\",\n \"name\": \"Sander Vleugelhof\",\n \"firstName\": \"Sander\",\n \"id\": 25513,\n \"middleName\": \"\",\n \"login\": \"sander.v@gmail.com\",\n \"phone\": \"0032445888\",\n \"title\": \"Mr.\",\n \"email\": \"sander.v@gmail.com\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 1,\n \"total\": 2,\n \"offset\": 12,\n \"itemsFound\": 2,\n \"end\": 2,\n \"page\": 1\n}"},{"id":"eeafc87b-bd8e-4a0f-84e4-4b7fef11d3be","name":"Search Customers - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sander\",\r\n \"dateCreated\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"dateModified\": {\r\n \"from\": \"2020-12-12T00:00:00\",\r\n \"to\": \"2023-12-12T00:00:00\"\r\n },\r\n \"offset\": 12,\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/customers/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Tue, 22 Aug 2023 08:26:19 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"1da8c50c-e46e-4586-b9ae-1f40c24d8452"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [name] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"d2c649ca-a236-40fd-9ff0-c116e89b7562"}],"id":"94da368b-74d2-41f1-814b-765195fd87df","description":"

Customers represent data about a specific customer. Carts, orders, attributes, addresses are associated with customers.

In a B2C environment a customer is the actual user ordering products.

\n
The customer API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API
\n

Customer Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller `customer` id
sourceId	string	External system unique id. sourceId should be combined with source

What are lookup keys?

Fields

Name	Description	Type
debtorId	A unique id representing this customer. A debtorId can be automatically generated by Propellor	integer string
firstName	Customer first name	string
middleName	Customer middle name	string
lastName	Customer last name	string
abbreviation	Customer abbreviation	string
title	Customer title	string
dateOfBirth	Customer date of birth	date
gender	Customer gender	enum m=Male f=Female u=Undefined
login	Login name used to login to the webshop	string
phone	Customer phone number	integer
email	A valid email address	string
ssn	Customer ssn	integer
parent	Parent usergroup	JSON object that identifies the parent. `id` or `sourceId` in combination with source
pricelistAmount	A `pricesheet` code in case of special pricing agreements	string
pricelistPercentage	A `pricesheet` code in case of special pricing agreements	string
primaryLanguage	Customer primary language	ISO 639-1
sourceId	External system unique id	string
source	External system	string

Customer Errors

This section describes error codes specific for the Customer resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
60004	CustomerExists	400	Customer already exists	Customer with such lookup key already exists
60005	CustomerMultipleFound	400	Multuple customers found. Please provide additional filters	Multiple customers with such lookup key exist
60006	CustomerNotFound	404	Customer does not exist	Customer with such lookup key not found
60007	ParentCustomerNotFound	404	Parent customer does not exist	Parent customer with such lookup key not found. This error is typical when working with customer sub-resources (e.g. attributes, addresses)
60008	CustomerNotAllowed	405	Customer is not allowed	Usually when customer is in Recycle Bin and can't be used
90006	AddressNotFound	404	Address does not exist	Customer address does not exist

","_postman_id":"94da368b-74d2-41f1-814b-765195fd87df","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Orders","item":[{"name":"Shipments","item":[{"name":"Create Shipment","id":"563af6ca-7aff-442c-b10a-62136d981af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"colli\": 1,\r\n \"supplier\": \"INTERN\",\r\n \"notes\": \"\",\r\n \"deliveryDate\": \"2022-05-21T00:00:00\",\r\n \"deliveryId\": \"D185FA63-38F0-4612-B4413FA5B71E3CE4\",\r\n \"items\": [\r\n {\r\n \"supplierCode\": \"390307\",\r\n \"sku\": \"390307\",\r\n \"name\": \"Gallagher MBS400 fence energiser (230V/12V/Solar)\",\r\n \"quantity\": 1,\r\n \"notes\": \"\",\r\n \"externalLineId\": \"\"\r\n }\r\n ],\r\n \"tracktrace\": [\r\n {\r\n \"carrierName\": \"DHL\",\r\n \"code\": \"12345\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/shipments","description":"

Create a shipment which marks orderItems as delivered and adds track and trace information to the order.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
deliveryId	yes
deliveryDate	no
supplier	yes
colli	no
notes	no
shipDate	no
items	yes
items.sku	yes
items.name	yes
items.supplierCode	no
items.quantity	yes
items.cancelled	no Default is `0`
items.notes	no
items.externalLineId	no
tracktrace	no
tracktrace.carrierName	yes
carrierName.code	yes

Use id or externalId

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"195","key":"lookupValue"}]}},"response":[{"id":"86421590-0c4f-49f5-8338-79794a1d6aa8","name":"Create Shipment - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"colli\": 1,\r\n \"supplier\": \"INTERN\",\r\n \"notes\": \"\",\r\n \"deliveryDate\": \"2022-05-21T00:00:00\",\r\n \"deliveryId\": \"D185FA63-38F0-4612-B4413FA5B71E3CE4\",\r\n \"items\": [\r\n {\r\n \"supplierCode\": \"390307\",\r\n \"sku\": \"390307\",\r\n \"name\": \"Gallagher MBS400 fence energiser (230V/12V/Solar)\",\r\n \"quantity\": 1,\r\n \"notes\": \"\",\r\n \"externalLineId\": \"\"\r\n }\r\n ],\r\n \"tracktrace\": [\r\n {\r\n \"carrierName\": \"DHL\",\r\n \"code\": \"12345\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/shipments","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","shipments"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"55"},{"key":"date","value":"Mon, 25 Apr 2022 18:04:26 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"69b34018-6b10-4362-bdde-21a2125b7925"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Shipment created\"\n ],\n \"total\": 1\n}"},{"id":"72df1802-b5cd-4b8d-afff-36892af25786","name":"Create Shipment - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"colli\": 1,\r\n \"shipDate\": \"\",\r\n \"supplier\": \"INTERN\",\r\n \"notes\": \"\",\r\n \"deliveryDate\": \"2021-06-21T00:00:00\",\r\n \"deliveryId\": \"D185FA63-38F0-4612-B4413FA5B71E3CE6\",\r\n \"items\": [\r\n {\r\n \"supplierCode\": \"434831\",\r\n \"code\": \"434831\",\r\n \"name\": \"USB-stick 2.0 Integral 16GB neon blauw\",\r\n \"quantity\": 1,\r\n \"notes\": \"\",\r\n \"externalLineId\": \"\"\r\n }\r\n ],\r\n \"tracktrace\": [\r\n {\r\n \"carrierName\": \"DHL\",\r\n \"code\": \"12345\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/shipments","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","shipments"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"160","description":"The `id` or `externalId` of the order"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"234"},{"key":"date","value":"Mon, 25 Apr 2022 17:46:18 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b11b44a6-a84b-4868-b66a-668d718e2dac"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/items/0: required key [sku] not found\",\n \"#/items/0: extraneous key [code] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"340a4db3-8a1a-46f5-b609-6d1e2889828c","name":"Create Shipment - 404 (order not found)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"colli\": 1,\r\n \"supplier\": \"INTERN\",\r\n \"notes\": \"\",\r\n \"deliveryDate\": \"2022-05-21T00:00:00\",\r\n \"deliveryId\": \"D185FA63-38F0-4612-B4413FA5B71E3CE6\",\r\n \"items\": [\r\n {\r\n \"supplierCode\": \"390307\",\r\n \"sku\": \"390307\",\r\n \"name\": \"Gallagher MBS400 fence energiser (230V/12V/Solar)\",\r\n \"quantity\": 1,\r\n \"notes\": \"\",\r\n \"externalLineId\": \"\"\r\n }\r\n ],\r\n \"tracktrace\": [\r\n {\r\n \"carrierName\": \"DHL\",\r\n \"code\": \"12345\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/shipments","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","shipments"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"300","description":"The `id` or `externalId` of the order"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"160"},{"key":"date","value":"Mon, 25 Apr 2022 18:10:08 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c0e35a45-6752-466c-bab2-f7034f9d516f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15001\",\n \"messages\": [\n \"Order with id [300] not found\"\n ],\n \"status\": 404,\n \"code\": 15001,\n \"type\": \"OrderNotFound\"\n }\n}"}],"_postman_id":"563af6ca-7aff-442c-b10a-62136d981af8"},{"name":"Get Shipments","id":"62352118-b24b-4c17-b6a6-3b30496b3550","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/shipments","description":"

Use this endpoint to retrieve a list of all order shipments.

Use id or externalId

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"195","key":"lookupValue"}]}},"response":[{"id":"d193a6b5-a7ca-4ae0-8991-8bbcb80f18a2","name":"Get Shipments - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/shipments","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","shipments"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"295","description":"The `id` or `externalId` of the order"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"155"},{"key":"date","value":"Thu, 28 Apr 2022 17:38:39 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e8d06185-f61c-414e-a2a0-5b7fda9e6974"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15001\",\n \"messages\": [\n \"Order with id [295] not found\"\n ],\n \"status\": 404,\n \"code\": 15001,\n \"type\": \"OrderNotFound\"\n }\n}"}],"_postman_id":"62352118-b24b-4c17-b6a6-3b30496b3550"}],"id":"d0f5eaa0-c316-405a-a72e-ae30e8cf8eba","description":"

Shipments contain information on how/when/which items of an order are being shipped to the customer. A shipment message typically contains one or multiple items and one or more track and trace codes.

Shipments can only be added to an order when the order has been processed.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
deliveryId	Shipment unique delivery ID	string
deliveryDate	Delivery date	date
supplier	Goods supplier	string
colli	Number of items of the packing units	integer
notes	Notes	string
shipDate	Shipping date	date
items	Shipped items	array
items.sku	Item sku	string
items.name	Item name	string
items.supplierCode	Item supplier code	string
items.quantity	Delivered quantity	integer
items.cancelled	Cancelled quantity	integer
items.notes	Item notes	string
items.externalLineId	Shipping item ID in external system (delivery, warehouse system)	string
tracktrace	Track and trace codes of package	array
tracktrace.carrierName	Package carrier	string
carrierName.code	Track and trace code	string

","_postman_id":"d0f5eaa0-c316-405a-a72e-ae30e8cf8eba","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Addresses","item":[{"name":"Get Addresses by type","id":"e842bc8c-f688-496a-8d4d-56c4e1958cc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses?type=delivery","description":"

Use this endpoint to retrieve a list of all order addresses. Addresses can be filtered by type.

possible values:

delivery\ninvoice

\n","type":"text/plain"},"key":"type","value":"delivery"}],"variable":[{"description":{"content":"

Use id or externalId

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"195","key":"lookupValue"}]}},"response":[{"id":"6e20b7e4-db89-4480-97b2-8f7150c52f78","name":"Get Delivery Addresses - 200","originalRequest":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/orders/id/195/addresses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"795"},{"key":"date","value":"Wed, 23 Mar 2022 15:18:18 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"02c6664d-aa51-4758-bc86-082f9e5d9360"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"postalCode\": \"7323 KE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Serres\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"\",\n \"street\": \"Mazurkastraat 20\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Julien\",\n \"name\": \"\",\n \"id\": 81902,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"invoice\",\n \"region\": \"\",\n \"city\": \"Apeldoorn\",\n \"phone\": \"+31206717171\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"w.spies@propel.us\"\n },\n {\n \"postalCode\": \"7323 KE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Serres\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"20\",\n \"street\": \"Mazurkastraat\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Julien\",\n \"name\": \"\",\n \"id\": 81903,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Apeldoorn\",\n \"phone\": \"\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"\"\n }\n ],\n \"messages\": [],\n \"total\": 2\n}"},{"id":"8b3d9fbc-fedf-4251-871e-489babdbcebd","name":"Get Delivery Addresses - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses?type=delivery","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses"],"query":[{"key":"type","value":"delivery","description":"possible values:\n\ndelivery\ninvoice"}],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"295","description":"The `id` or `externalId` of the order "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Thu, 21 Apr 2022 12:12:29 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"bab637cc-d756-4eb9-9a3e-f27c648230e0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15003\",\n \"messages\": [\n \"Parent resource [Order] with id [295] not found\"\n ],\n \"status\": 404,\n \"code\": 15003,\n \"type\": \"ParentOrderNotFound\"\n }\n}"}],"_postman_id":"e842bc8c-f688-496a-8d4d-56c4e1958cc3"},{"name":"Get Address by ID","id":"be9eec61-ab6a-46b5-97b6-6a1b380fab4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to retrieve details for an order address. The address is identified by id.

Use id or externalId

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"195","key":"lookupValue"},{"description":{"content":"

Address ID

\n","type":"text/plain"},"type":"any","value":"81902","key":"addressId"}]}},"response":[{"id":"9fc873e1-4709-4ab4-ac39-0a5f3389aecc","name":"Get Address by ID - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order "},{"key":"addressId","value":"81902","description":"Address ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"428"},{"key":"date","value":"Wed, 23 Mar 2022 15:32:11 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"f4778ede-9757-4f1e-9f18-bb9d66589804"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"postalCode\": \"7323 KE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Serres\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"\",\n \"street\": \"Mazurkastraat 20\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Julien\",\n \"name\": \"\",\n \"id\": 81902,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"invoice\",\n \"region\": \"\",\n \"city\": \"Apeldoorn\",\n \"phone\": \"+31206717171\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"julien@propel.us\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"ac866a2f-bb39-4218-8f95-57b9ebcc7fbc","name":"Get Address by ID - 404 (order not found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"295","description":"The `id` or `externalId` of the order "},{"key":"addressId","value":"81902","description":"Address ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Thu, 21 Apr 2022 12:18:25 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"586fc4d5-106d-4a2f-9b40-825a8b933861"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15003\",\n \"messages\": [\n \"Parent resource [Order] with id [295] not found\"\n ],\n \"status\": 404,\n \"code\": 15003,\n \"type\": \"ParentOrderNotFound\"\n }\n}"},{"id":"31042a42-8afe-4207-a587-a05d72e64c0b","name":"Get Address by ID - 404 (address not found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order "},{"key":"addressId","value":"819021","description":"Address ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"194"},{"key":"date","value":"Wed, 23 Mar 2022 15:32:40 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"4e308b90-bc3a-44ad-9fda-a01dd9941af1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [819021] not found for [Order] with id [195]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"be9eec61-ab6a-46b5-97b6-6a1b380fab4e"},{"name":"Update Address","id":"4d21bfc0-4fb5-4eb8-bd37-91fdc762d4e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"postalCode\": \"7323 KE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","description":"

Use this endpoint to update an order address. The address is identified by id.

Use id or externalId

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"195","key":"lookupValue"},{"description":{"content":"

Address ID

\n","type":"text/plain"},"type":"any","value":"81902","key":"addressId"}]}},"response":[{"id":"b7d32b9d-5396-4bc1-8356-1604214321d5","name":"Update Address - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"postalCode\": \"7323 KE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order"},{"key":"addressId","value":"81902","description":"Address ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"90"},{"key":"date","value":"Thu, 21 Apr 2022 12:28:03 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"7eed9828-53e0-4a69-9d32-301874cdc022"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"postalCode\": \"7323 KE\",\n \"id\": 81902\n },\n \"messages\": [\n \"Address updated\"\n ],\n \"total\": 1\n}"},{"id":"4f4deb5a-30ff-4e70-bc7d-b900ba8d812d","name":"Update Address - 400 (invalid schema)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"postalCodes\": \"7323 KE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order"},{"key":"addressId","value":"81902","description":"Address ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"191"},{"key":"date","value":"Thu, 21 Apr 2022 12:30:36 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"d524d2ed-1e19-4ac3-a033-4417e0382d05"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [postalCodes] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"d9d0e4fc-f02c-4306-8a53-38393340455c","name":"Update Address - 404 (order not found)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"postalCode\": \"7323 KE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"295","description":"The `id` or `externalId` of the order"},{"key":"addressId","value":"81902","description":"Address ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Thu, 21 Apr 2022 12:32:12 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c7a66577-c903-4e4b-8ac7-8d73d4a806e8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15003\",\n \"messages\": [\n \"Parent resource [Order] with id [295] not found\"\n ],\n \"status\": 404,\n \"code\": 15003,\n \"type\": \"ParentOrderNotFound\"\n }\n}"},{"id":"2923a33a-b26e-485a-a531-6c6fa1a4e50b","name":"Update Address - 404 (address not found)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"postalCode\": \"7323 KE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/addresses/:addressId","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","addresses",":addressId"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order"},{"key":"addressId","value":"819021","description":"Address ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"194"},{"key":"date","value":"Thu, 21 Apr 2022 12:32:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"ea4c8715-cbc3-46c9-bdc8-22db40ebe4ad"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90006\",\n \"messages\": [\n \"Address with id [819021] not found for [Orders] with id [195]\"\n ],\n \"status\": 404,\n \"code\": 90006,\n \"type\": \"AddressNotFound\"\n }\n}"}],"_postman_id":"4d21bfc0-4fb5-4eb8-bd37-91fdc762d4e9"}],"id":"ad258379-62e5-4dad-882f-bddeed137ddc","description":"

The Orders Addresses endpoints can be used to manage order addresses. An order can have one address of type: delivery and invoice.

Fields

Name	Description	Type
code	Address code	string
firstName	First name	string
middleName	Middle name	string
lastName	Last name	string
gender	Gender	enum M=Male F=Female U=Undefined
street	Street	string
number	Number	string
numberExtension	Number extension	string
postalCode	Postal code	string
city	City	string
country	Country	string
region	Region	string
icp	Indicates whether tax should be calculated when goods are delivered at this address	enum Y = Yes N = No
phone	Phone number	string
mobile	Mobile number	string
email	A valid email address	string
company	Organization the address is located at (if any)	string
url	Website	string
isDefault	Is this address the default address for the user of the provided type?	enum Y = Yes N = No
notes	Helpful notes for locating the address, etc.	string

","_postman_id":"ad258379-62e5-4dad-882f-bddeed137ddc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Order by lookup key","id":"ac83ea4a-ab5c-45d1-af2d-37efa1910939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue?expands=orderitems","description":"

Retrieve order details by a specific lookupKey / lookupId combination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

lookupKeys
id
sourceId

What are lookup keys?

Optional. Use orderitems to retrieve the orderitems of the order. Use orderitems.product to retrive product details for each orderitem.

\n","type":"text/plain"},"key":"expands","value":"orderitems"}],"variable":[{"description":{"content":"

Use id or externalId

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"100","key":"lookupValue"}]}},"response":[{"id":"a77e6f9e-265c-4859-b29d-0e688316c621","name":"GET order by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue?expands=orderitems","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"orderitems","description":"Optional. Use `orderitems` to retrieve the orderitems of the order. Use `orderitems.product` to retrive product details for each orderitem."}],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"2295"},{"key":"date","value":"Thu, 24 Mar 2022 12:17:26 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"9833f0d7-ea4c-475e-9121-b0558c4083f7"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shop\": {\n \"name\": \"Propellor Sonar\",\n \"id\": 1\n },\n \"id\": 195,\n \"channelId\": 1,\n \"shopId\": 1,\n \"userId\": 14718,\n \"debtorId\": \"753953\",\n \"firstName\": \"Julien\",\n \"middleName\": \"\",\n \"lastName\": \"Serres\",\n \"email\": \"\",\n \"date\": \"2022-03-16T15:00:55\",\n \"status\": \"CONFIRMED\",\n \"type\": \"dropshipment\",\n \"remarks\": \"\",\n \"reference\": \"\",\n \"extraInfo\": \"\",\n \"paymentData\": {\n \"payStatus\": \"\",\n \"netAmount\": 0,\n \"tax\": 0,\n \"taxPercentage\": 21,\n \"transactionId\": \"\",\n \"payMethod\": \"\",\n \"paystatusdate\": \"\",\n \"grossAmount\": 0\n },\n \"itemCount\": 1,\n \"language\": \"EN-US\",\n \"total\": {\n \"discountPercentage\": 0,\n \"tax\": {\n \"21\": 0,\n \"11\": 32.2234\n },\n \"discountValue\": 0,\n \"totalNet\": 325.16340,\n \"totalGross\": 292.94000\n },\n \"postageData\": {\n \"shippingMethod\": \"\",\n \"postageTaxPercentage\": 21,\n \"requestDate\": \"\",\n \"postage\": 0,\n \"pickUpLocationId\": 0,\n \"carrier\": \"\",\n \"postageNet\": 0,\n \"partialDeliveryAllowed\": \"Y\"\n },\n \"source\": \"intern\",\n \"externalId\": \"\",\n \"clientData\": {},\n \"invoiceData\": {\n \"address\": {\n \"postalCode\": \"7323 KE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Serres\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"\",\n \"street\": \"Mazurkastraat 20\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Julien\",\n \"name\": \"\",\n \"id\": 81902,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"invoice\",\n \"region\": \"\",\n \"city\": \"Apeldoorn\",\n \"phone\": \"+31206717171\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"julien@propel.us\"\n }\n },\n \"shippingData\": {\n \"address\": {\n \"postalCode\": \"7323 KE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Serres\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"20\",\n \"street\": \"Mazurkastraat\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Julien\",\n \"name\": \"\",\n \"id\": 81903,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Apeldoorn\",\n \"phone\": \"\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"\"\n }\n },\n \"items\": [\n {\n \"childItems\": [],\n \"discountAmountNet\": 0,\n \"discountPercentage\": 0,\n \"discountAmountTotal\": 0,\n \"price\": 292.94000,\n \"notes\": \"\",\n \"sku\": \"390307\",\n \"taxCode\": \"L\",\n \"taxPercentage\": 11,\n \"supplierCode\": \"390307\",\n \"discountAmount\": 0,\n \"discountAmountTotalNet\": 0,\n \"name\": \"Gallagher MBS400 fence energiser (230V/12V/Solar)\",\n \"quantity\": 1,\n \"type\": \"product\",\n \"unit\": 1,\n \"supplier\": \"INTERN\"\n }\n ]\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"669ba312-231b-49ad-a808-d8ac5e3d797b","name":"GET order by id - 400 (invalid lookupKey)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"162","description":"The `id` or `externalId` of the order"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"221"},{"key":"date","value":"Wed, 09 Mar 2022 01:18:45 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"8bc64fbe-e85a-4361-938d-8b2cbeb867b4"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [id1], key must contain one of the following values: [id,externalId]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"},{"id":"310e9519-c179-4bd7-8a71-c147ccb99e4b","name":"GET order by id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupValue","value":"162222","description":"The `id` or `externalId` of the order"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"163"},{"key":"date","value":"Mon, 07 Mar 2022 15:41:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e1918395-a63c-9e8a-b346-e3deb080aa3d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15001\",\n \"messages\": [\n \"Order with id [162222] not found\"\n ],\n \"status\": 404,\n \"code\": 15001,\n \"type\": \"OrderNotFound\"\n }\n}"}],"_postman_id":"ac83ea4a-ab5c-45d1-af2d-37efa1910939"},{"name":"Create Order","id":"6136df59-e8f5-4023-ae3f-408e79b4f3c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2023-03-03T13:10:45\",\r\n \"source\": \"MsBusinessCentral\",\r\n \"sourceId\": \"order-1234\",\r\n \"language\": \"EN\",\r\n \"status\": \"NEW\",\r\n \"channelId\": 1,\r\n \"reference\": \"reference text\",\r\n \"remarks\": \"remarks text\",\r\n \"extraInfo\": \"extrainfo text\",\r\n \"clientData\": {\r\n \"contact\": {\r\n \"source\": \"MsBusinessCentral\",\r\n \"sourceId\": \"contact-123478\"\r\n }\r\n },\r\n \"merchantCost\": 4.90,\r\n \"accountingId\": \"\",\r\n \"trackTraceCode\": \"\",\r\n \"total\": {\r\n \"discountAmount\": 5\r\n },\r\n \"shippingData\": {\r\n \"address\": {\r\n \"postalCode\": \"6822 DE\",\r\n \"icp\": \"N\",\r\n \"company\": \"Propel\",\r\n \"country\": \"NL\",\r\n \"notes\": \"Address notes\",\r\n \"lastName\": \"McCoy\",\r\n \"mobile\": \"0038975648\",\r\n \"number\": \"34\",\r\n \"street\": \"Noordpad\",\r\n \"url\": \"www.propel.us\",\r\n \"code\": \"11234\",\r\n \"gender\": \"U\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"region\": \"\",\r\n \"city\": \"Arnhem\",\r\n \"phone\": \"0032445888\",\r\n \"numberExtension\": \"A\",\r\n \"email\": \"miles@propel.us\"\r\n }\r\n },\r\n \"invoiceData\": {\r\n \"address\": {\r\n \"postalCode\": \"6822 DE\",\r\n \"icp\": \"N\",\r\n \"company\": \"Propel\",\r\n \"country\": \"NL\",\r\n \"notes\": \"Address notes\",\r\n \"lastName\": \"McCoy\",\r\n \"mobile\": \"0038975648\",\r\n \"number\": \"34\",\r\n \"street\": \"Noordpad\",\r\n \"url\": \"www.propel.us\",\r\n \"code\": \"11234\",\r\n \"gender\": \"U\",\r\n \"firstName\": \"Miles\",\r\n \"middleName\": \"\",\r\n \"region\": \"\",\r\n \"city\": \"Arnhem\",\r\n \"phone\": \"0032445888\",\r\n \"numberExtension\": \"A\",\r\n \"email\": \"miles@propel.us\"\r\n }\r\n },\r\n \"items\": [\r\n {\r\n \"type\": \"product\",\r\n \"sku\": \"411544\",\r\n \"quantity\": 2\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/","description":"

Use this endpoint to create an order.

Order identification

Orders imported via the REST api need to specify an orderidentifier. This identifier is used by Propeller to determine if an order has already been imported before into Propellor or not.

{\n    \"source\" : \"MsBusinessCentral\",\n    \"sourceId :  \"order-1234\"\n}\n\n

Create an order using an existing user resource

Orders can be created referencing an existing user / contact or customer resource. A user resource can be referenced using a lookupKey in the clientData element.

{\n    \"clientData\": {\n        \"user\": {\n            \"source\" : \"MsBusinessCentral\",\n            \"sourceId :  \"user-1234\"\n        }\n    }\n}\n\n

Create an order using the anonymous user

Creating an order can be done without referencing an existing user,contact or customer object. When no clientDataelement is present in the payload a firstName, middleName, lastName and email needs to be present in the root or the order payload.

{\n    \"firstName\" : \"Miles\",\n    \"middleName\" : \"\",\n    \"lastName\" : \"McCoy\",\n    \"email\" : \"miles@propel.us\"\n}\n\n

Anonymous orders are not linked to any existing user / contact or customer resource in Propeller. Anonymous orders are e.g. usefull when Propeller acts as a \"in between\" a marketplace (e.g. Amazon) and an ERP system. Marketplace orders are imported into Propeller and from Propeller exported to the ERP system. There is no added value of creating separate users for each Marketplace order in Propeller.

Referencing products as order items

an orderItem always contains a reference to an existing product using a lookupKey

{\n   \"type\": \"product\",\n   \"source\" : \"MsBusinessCentral\",\n   \"sourceId :  \"product-1234\"\n}\n\n

Update order headers details. This request does not support updating orderitems. An order address can be updated using the order address endpoints.

Orders are referenced by a lookupKey / lookupId combination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

lookupKeys
id
sourceId

What are lookup keys?

Use id or externalId

id - Integer

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"1600","key":"lookupValue"}]}},"response":[{"id":"ce2aa5c4-2300-4e0f-aecb-dbbf274e7c69","name":"Update Order - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"exportDate\":\"2022-02-24 19:38:19\",\r\n \"exportStatus\":\"EXPORTED\",\r\n \"exportMessage\":\"ERP order id: 50001\",\r\n \"status\" : \"ARCHIVED\",\r\n \"externalId\" : \"50001\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/id/162"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1905"},{"key":"date","value":"Mon, 07 Mar 2022 15:47:51 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"fcbdb98f-f9ef-4b57-a63b-0e5a60b87d09"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 162,\n \"siteId\": 100037,\n \"shopId\": 1,\n \"userId\": 14711,\n \"debtorId\": \"\",\n \"firstName\": \"Sander\",\n \"middleName\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"email\": \"\",\n \"date\": \"2022-02-24T14:14:55\",\n \"status\": \"ARCHIVED\",\n \"type\": \"dropshipment\",\n \"remarks\": \"\",\n \"reference\": \"\",\n \"extraInfo\": \"\",\n \"paymentData\": {\n \"payStatus\": \"\",\n \"netAmount\": 0,\n \"tax\": 0,\n \"taxPercentage\": 21,\n \"transactionId\": \"\",\n \"payMethod\": \"\",\n \"paystatusdate\": \"\",\n \"grossAmount\": 0\n },\n \"itemCount\": 1,\n \"language\": \"EN-US\",\n \"total\": {\n \"discountPercentage\": 0,\n \"tax\": {\n \"21\": 3.15\n },\n \"discountValue\": 0,\n \"totalNet\": 24.2,\n \"totalGross\": 20\n },\n \"postageData\": {\n \"shippingMethod\": \"\",\n \"postageTaxPercentage\": 21,\n \"requestDate\": \"\",\n \"postage\": 5,\n \"carrier\": \"\",\n \"postageNet\": 6.05,\n \"partialDeliveryAllowed\": \"Y\"\n },\n \"source\": \"intern\",\n \"externalId\": \"50001\",\n \"clientData\": {\n \"ssn\": \"\",\n \"company\": \"\",\n \"debtorId\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"mobile\": \"undefined\",\n \"abbreviation\": \"SV\",\n \"fullName\": \"Sander Vleugelhof\",\n \"dateOfBirth\": \"\",\n \"gender\": \"U\",\n \"vatNumber\": \"\",\n \"firstName\": \"Sander\",\n \"id\": 14711,\n \"middleName\": \"\",\n \"login\": \"sander123@propel.us\",\n \"phone\": \"020-6717171\",\n \"title\": \"\",\n \"email\": \"sander123@propel.us\"\n },\n \"invoiceData\": {\n \"address\": {\n \"postalCode\": \"1234 AB\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"257\",\n \"street\": \"Gedempt Hamerkanaal\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Sander\",\n \"name\": \"\",\n \"id\": 81752,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"invoice\",\n \"region\": \"\",\n \"city\": \"Amsterdam\",\n \"phone\": \"\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"\"\n }\n },\n \"shippingData\": {\n \"address\": {\n \"postalCode\": \"1234 AB\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"257\",\n \"street\": \"Gedempt Hamerkanaal\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Sander\",\n \"name\": \"\",\n \"id\": 81753,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Amsterdam\",\n \"phone\": \"\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"\"\n }\n }\n },\n \"messages\": [\n \"Updated\"\n ],\n \"total\": 1\n}"},{"id":"6e1ac356-e810-44b3-b4e7-b442485cb08a","name":"Update Order postage data - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"postageData\": {\r\n \"requestDate\": \"2023-11-02T00:00:00\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/id/162"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1905"},{"key":"date","value":"Mon, 07 Mar 2022 15:47:51 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"fcbdb98f-f9ef-4b57-a63b-0e5a60b87d09"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 162,\n \"siteId\": 100037,\n \"shopId\": 1,\n \"userId\": 14711,\n \"debtorId\": \"\",\n \"firstName\": \"Sander\",\n \"middleName\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"email\": \"\",\n \"date\": \"2022-02-24T14:14:55\",\n \"status\": \"ARCHIVED\",\n \"type\": \"dropshipment\",\n \"remarks\": \"\",\n \"reference\": \"\",\n \"extraInfo\": \"\",\n \"paymentData\": {\n \"payStatus\": \"\",\n \"netAmount\": 0,\n \"tax\": 0,\n \"taxPercentage\": 21,\n \"transactionId\": \"\",\n \"payMethod\": \"\",\n \"paystatusdate\": \"\",\n \"grossAmount\": 0\n },\n \"itemCount\": 1,\n \"language\": \"EN-US\",\n \"total\": {\n \"discountPercentage\": 0,\n \"tax\": {\n \"21\": 3.15\n },\n \"discountValue\": 0,\n \"totalNet\": 24.2,\n \"totalGross\": 20\n },\n \"postageData\": {\n \"shippingMethod\": \"\",\n \"postageTaxPercentage\": 21,\n \"requestDate\": \"\",\n \"postage\": 5,\n \"carrier\": \"\",\n \"postageNet\": 6.05,\n \"partialDeliveryAllowed\": \"Y\"\n },\n \"source\": \"intern\",\n \"externalId\": \"50001\",\n \"clientData\": {\n \"ssn\": \"\",\n \"company\": \"\",\n \"debtorId\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"mobile\": \"undefined\",\n \"abbreviation\": \"SV\",\n \"fullName\": \"Sander Vleugelhof\",\n \"dateOfBirth\": \"\",\n \"gender\": \"U\",\n \"vatNumber\": \"\",\n \"firstName\": \"Sander\",\n \"id\": 14711,\n \"middleName\": \"\",\n \"login\": \"sander123@propel.us\",\n \"phone\": \"020-6717171\",\n \"title\": \"\",\n \"email\": \"sander123@propel.us\"\n },\n \"invoiceData\": {\n \"address\": {\n \"postalCode\": \"1234 AB\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"257\",\n \"street\": \"Gedempt Hamerkanaal\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Sander\",\n \"name\": \"\",\n \"id\": 81752,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"invoice\",\n \"region\": \"\",\n \"city\": \"Amsterdam\",\n \"phone\": \"\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"\"\n }\n },\n \"shippingData\": {\n \"address\": {\n \"postalCode\": \"1234 AB\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Vleugelhof\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"257\",\n \"street\": \"Gedempt Hamerkanaal\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Sander\",\n \"name\": \"\",\n \"id\": 81753,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Amsterdam\",\n \"phone\": \"\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"\"\n }\n }\n },\n \"messages\": [\n \"Updated\"\n ],\n \"total\": 1\n}"},{"id":"80d8deeb-8fd8-40a7-ac42-0f341a15e5d9","name":"Update Order - 400 (invalide fieldname)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"exportDate\":\"2022-02-24 19:38:19\",\r\n \"exportStatus\":\"EXPORTED\",\r\n \"exportMessage\":\"ERP order id: 50001\",\r\n \"status\" : \"ARCHIVED\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/id/122"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"184"},{"key":"date","value":"Thu, 24 Feb 2022 18:46:31 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"a7b7ade4-1d73-41e5-8cee-d359132a1f58"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [Date] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"fe02062b-d6e4-410c-9ca0-e17cbf49fd20","name":"Update Order - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"exportDate\":\"2022-02-24 19:38:19\",\r\n \"exportStatus\":\"EXPORTED\",\r\n \"exportMessage\":\"ERP order id: 50001\",\r\n \"status\" : \"ARCHIVED\",\r\n \"externalId\" : \"50001\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/id/1600"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"161"},{"key":"date","value":"Wed, 09 Mar 2022 01:21:25 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"62ae4fed-c086-4764-a970-aa5be35fb988"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15001\",\n \"messages\": [\n \"Order with id [1600] not found\"\n ],\n \"status\": 404,\n \"code\": 15001,\n \"type\": \"OrderNotFound\"\n }\n}"}],"_postman_id":"4c0c4d71-2931-47eb-9c0f-ea19df1083ff"},{"name":"Search Orders","id":"fba52fc0-97e5-48d9-9593-99df74663e30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"VALIDATED\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/orders/search?expands=orderItems","description":"

Retrieve a list of orders by using the search fields below

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required
status	string	no
exported	boolean	no
externalOrderNumber	string	no
dateCreated	DateFilter	no
dateStatusModified	DateFilter	no

status: the value of the status in Propeller. By default the available statuses are:

NEW
VALIDATED
CONFIRMED
ARCHIVED

It is possible to create custom statuses in Propeller, please consult the Propeller backoffice for custom status values.

exported: Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Once an order has been exported it is good practice to mark the order as exported using the order update api. Searching for orders using the exported field will return a list of orders which are (or not) exported to an external system.

externalOrderNumber: Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Depending on the type of system / techniques used for exporting, Propeller gets back an identifier from these systems (e.g an order id / invoice id). This id is stored in Propellor and can be used for searching using the order search api.

Date filter

A date filter is a special date search object that can search through a range:

{\n    \"from\": \"2020-12-12T00:00:00\",\n    \"to\": \"2022-12-12T00:00:00\"\n}\n\n

Process an order by a specific lookupKey / lookupId combination.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

lookupKeys
id
externalId

What are lookup keys?

Processing an order does the following:

for each supplier in the order a purchase order and backorder is created
the order is set to status CONFIRMED

Once an order is processed, shipments / track and trace codes can be booked on backorders.

Use id or externalId

id - Integer

\n","type":"text/plain"},"type":"string","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

id - Integer, externalId - String

\n","type":"text/plain"},"type":"any","value":"195","key":"lookupValue"}]}},"response":[{"id":"24e503e2-13ea-4786-a0e8-a75045314b74","name":"Process order by lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/process","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","process"],"variable":[{"key":"lookupKey","value":"id","type":"string","description":"Use `id` or `externalId`\n\n`id` - Integer"},{"key":"lookupValue","value":"195","description":"The `id` or `externalId` of the order \n\n`id` - Integer, `externalId` - String"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1948"},{"key":"date","value":"Wed, 23 Mar 2022 15:38:11 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"ccfe1260-b39d-45f7-a0f1-5135c1b578b1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 195,\n \"siteId\": 100037,\n \"shopId\": 1,\n \"userId\": 14718,\n \"debtorId\": \"753953\",\n \"firstName\": \"Julien\",\n \"middleName\": \"\",\n \"lastName\": \"Serres\",\n \"email\": \"\",\n \"date\": \"2022-03-16T15:00:55\",\n \"status\": \"CONFIRMED\",\n \"type\": \"dropshipment\",\n \"remarks\": \"\",\n \"reference\": \"\",\n \"extraInfo\": \"\",\n \"paymentData\": {\n \"payStatus\": \"\",\n \"netAmount\": 0,\n \"tax\": 0,\n \"taxPercentage\": 21,\n \"transactionId\": \"\",\n \"payMethod\": \"\",\n \"paystatusdate\": \"\",\n \"grossAmount\": 0\n },\n \"itemCount\": 1,\n \"language\": \"EN-US\",\n \"total\": {\n \"discountPercentage\": 0,\n \"tax\": {\n \"11\": 32.2234,\n \"21\": 0\n },\n \"discountValue\": 0,\n \"totalNet\": 325.1634,\n \"totalGross\": 292.94\n },\n \"postageData\": {\n \"shippingMethod\": \"\",\n \"postageTaxPercentage\": 21,\n \"requestDate\": \"\",\n \"postage\": 0,\n \"carrier\": \"\",\n \"postageNet\": 0,\n \"partialDeliveryAllowed\": \"Y\"\n },\n \"source\": \"intern\",\n \"externalId\": \"\",\n \"clientData\": {\n \"ssn\": \"\",\n \"company\": \"Propellor\",\n \"debtorId\": \"753953\",\n \"lastName\": \"Serres\",\n \"mobile\": \"06-12345678\",\n \"abbreviation\": \"JS\",\n \"fullName\": \"Jullien Serres\",\n \"dateOfBirth\": \"\",\n \"gender\": \"M\",\n \"vatNumber\": \"\",\n \"firstName\": \"Jullien\",\n \"id\": 14718,\n \"middleName\": \"\",\n \"login\": \"julielarue@propellor.eu\",\n \"phone\": \"020-6717171\",\n \"title\": \"\",\n \"email\": \"julielarue@propellor.eu\"\n },\n \"invoiceData\": {\n \"address\": {\n \"postalCode\": \"7323 KE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Serres\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"\",\n \"street\": \"Mazurkastraat 20\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Julien\",\n \"name\": \"\",\n \"id\": 81902,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"invoice\",\n \"region\": \"\",\n \"city\": \"Apeldoorn\",\n \"phone\": \"+31206717171\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"w.spies@propel.us\"\n }\n },\n \"shippingData\": {\n \"address\": {\n \"postalCode\": \"7323 KE\",\n \"icp\": \"N\",\n \"company\": \"\",\n \"country\": \"NL\",\n \"notes\": \"\",\n \"lastName\": \"Serres\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"number\": \"20\",\n \"street\": \"Mazurkastraat\",\n \"url\": \"\",\n \"code\": \"\",\n \"gender\": \"U\",\n \"firstName\": \"Julien\",\n \"name\": \"\",\n \"id\": 81903,\n \"middleName\": \"\",\n \"active\": \"Y\",\n \"type\": \"delivery\",\n \"region\": \"\",\n \"city\": \"Apeldoorn\",\n \"phone\": \"\",\n \"numberExtension\": \"\",\n \"isDefault\": \"N\",\n \"email\": \"\"\n }\n }\n },\n \"messages\": [\n \"Order processed\"\n ],\n \"total\": 1\n}"},{"id":"92909d6e-53d5-4678-947f-6f9903d4e3c9","name":"Order process by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupValue/process","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupValue","process"],"variable":[{"key":"lookupKey","value":"id","type":"string","description":"Use `id` or `externalId`\n\n`id` - Integer"},{"key":"lookupValue","value":"295","description":"The `id` or `externalId` of the order \n\n`id` - Integer, `externalId` - String"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"160"},{"key":"date","value":"Wed, 23 Mar 2022 15:38:52 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"54f24187-0fd5-42ad-a456-2f0aa887f653"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15001\",\n \"messages\": [\n \"Order with id [295] not found\"\n ],\n \"status\": 404,\n \"code\": 15001,\n \"type\": \"OrderNotFound\"\n }\n}"}],"_postman_id":"d2f5043e-854e-4391-b458-972c657c9f05"},{"name":"Order PDF by lookup key","id":"71b81505-2f2d-41ab-9233-53ccc151e872","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupId/pdf","description":"

Generate a base64 encoded version of the order confirmation pdf based on the Propeller order confirmation template

Reference an order by a specific lookupKey / lookupId combination.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

lookupKeys
id
externalId

What are lookup keys?

Use id or externalId

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or externalId of the order

\n","type":"text/plain"},"type":"any","value":"195","key":"lookupId"}]}},"response":[{"id":"c96b95c5-2936-4ce0-809d-03efbd943274","name":"Order PDF by lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupId/pdf","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupId","pdf"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`"},{"key":"lookupId","value":"162","description":"The `id` or `externalId` of the order"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"21718"},{"key":"date","value":"Thu, 24 Feb 2022 18:56:42 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"01511fec-9d3a-485f-b8fb-30a746ca0921"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"fileName\": \"order-162.pdf\",\n \"contentType\": \"application/pdf\",\n \"base64\": \"JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDE1MzQ+PnN0cmVhbQp4nK1Yy3LbNhTd8yvupjPtTAzjTdCryrFbt06dhzXJotMFbdGWHD4UinKarPIp+dRegKBISg7JNk0mdjA65+C+cHGhD8HpPKBgJCNRBPNFcD4PXgcfAkqoCBV8DDj8jp8/BIzCH8Gff1FYBB+AKQr2r5IEQZxBaELCJdxmcLzK7imcFfAaNRRlkYb93+W93fT4FwaGcAXzu4A5NYZ6lEQGjJBEwDwLfnxVFuskTYvyp/mDNe1bPKoIB8PRHFnzVmlRJfmmKuO4Aing5n5YQUbaBsAwRZhxEoyqCJ5fwCzbVEm5iLMRExgnSDBoiWZO4Op8fnH+5sXs6ux6ZG8jiNIYQ01k5KjnR1m8Sk9gld8VP6+bGJA8HbNBExZBGKIvdfwu316egJBMGK3UiBWhIgLJOiRCO/Lp/N0JXL0ghkaYupCwMCSnlI3ISE0UFgTi6ziezq4unQwG6M3s9CWhjDLCKVaM1l6rrqamLjhEXUVbXiJsMvu1oRCjtQ5h/3crEhK1J6OIUf2ygusij0tYbTDU98nmdlkmj0kON6sHWCRwGWdJCY9xDpdFsV7G+SJJocCfJeTbzH6GodUCTwqBi6QCDNiR/wAVr15gQXJhpDYYNQIv1xCnaQIpblHa7XL4vHrIUfBzArP0PsmSPIFudJ/y4QjLrHbibVGUH+O4XKCQtbEqknW82aAygbMENd9v8wq2kMcprnCf9ddlVa1Pjo831mnS1lWyPbaVVmZxtUqOY2/K0WO7AfFmoQGGU3tSskCFEnPZrNNmzRmhEpe8998dahm8C3KbPWj+YcYYJldpQ5hGXW7Qab9K21XEcNUA3WIZ3AVcyhaddYX2wC1wxxWcd7k9qQNCC97xJaVdfk/ugNCCW35ouvye3AGhBe/4SukeP+wFbo/Qgnd8zIjAP7D/u0mIjPBM7RJSr5qEKGrbnI9xs+gkpOF2hPbAHtjl+pDt9u1KHRA8uMv3IWv4PbkDggf3+KHp8ntyBwQP7vJ9jHf8sBe4PYIHd/l7p8JF2rGMPW4O75fpboltVjRZ2a282LcapAgdN8I7m1k7dWRt8Ou0XeN95ALn4X7pItWjNK62Cn7pGfuCbax3At6dRqBZNgJ9Pefe0JUhQgNKGNuObKe83t5URRWn/d4a9W8/Rhjrkk4G0Eq4UmrBMATmPWO+DOq6gaqDZuoZpQMM5yn2Vllf2dfL1Rp7dwW3xabaTPC3pQ77G3ahg97WoWnBw/5GdnzooKe4S7ntYe4KnM3xkvlhgp8tZ9TPFjrBzxY8xc8WLZ/xnp/i0E9pcAqu0fNp1WsZT2VTPGV6Rx6GwLxnyZdBXVe9HTQ/dJP1BhpBIcQzH9VGvyztaHVb5HcrN4sU+YDPruOFOHNEpjcYPhlOag0LFSc86uy0iKtkYAdGTUOTcrR2GHrPe2gujyg/4pTzcdPwxHctwynyJikn2IaFRdVk21o00xOM4sqO8u5BYt8jEC8WZbIZaiuNWcjU422lTiEVhEaHKdzDRvhGEqAN83EaqlnuTluLPUvSFc7cnyY44Kl4noy/O2I3779Nk+19ki6Lu6Gm4NmakbD2/tdkkWTrCi7sS+J9nMdxClyFEzQUavgrgAsJs9P2ITrEjqTdWuNzXo/3ar9VC/7Gk3W/CSvMGJ+cC9FPxm/5Y7G6TSblQnxfMsT/kQ3xPekQyvyrfIj/lBB3jjReouETrXAPq4WbMKLIflsx7SB1wPhwXmxv+5PFQe8A+xLUdZ+5ivtfnOyBWajsLdrinxeLZMggvN466FlW4Bt3yBguu/hX5ephA+vjIfsllnaHgiPGyJUnoy5+7Kq24cHh1l+Q51t8hMdDNeEj1FKi0ESUR4oxnFaGikLRPnGw8mxcWygb1OWuglr030Pu+ufiJCtctlro0EQl6iuqa/PI6Cipnm6JK4Jplsj6yuugxTOmBgh+cpxmiHs8TDOkeTxMD4l/2O/641DfqB+Y+JALxei4VbcNKZEi+xdwllTLYjGUVxaRmqqj0UHW7yP07nzHn9zrZ+o2yDS9XexX36+DfwDszggXCmVuZHN0cmVhbQplbmRvYmoKMyAwIG9iago8PC9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udC9CYXNlRm9udC9IZWx2ZXRpY2EvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjQgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtUm9tYW4vRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjUgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtQm9sZC9FbmNvZGluZy9XaW5BbnNpRW5jb2Rpbmc+PgplbmRvYmoKNiAwIG9iago8PC9Db2xvclNwYWNlL0RldmljZVJHQi9TdWJ0eXBlL0ltYWdlL0hlaWdodCAxNDYvRmlsdGVyL0RDVERlY29kZS9UeXBlL1hPYmplY3QvV2lkdGggNDAwL0JpdHNQZXJDb21wb25lbnQgOC9MZW5ndGggMTMzOTM+PnN0cmVhbQr/2P/gABBKRklGAAEBAAABAAEAAP/bAEMAAwICAwICAwMDAwQDAwQFCAUFBAQFCgcHBggMCgwMCwoLCw0OEhANDhEOCwsQFhARExQVFRUMDxcYFhQYEhQVFP/bAEMBAwQEBQQFCQUFCRQNCw0UFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFP/AABEIAJIBkAMBIgACEQEDEQH/xAAeAAEAAgICAwEAAAAAAAAAAAAACAkHCgMGAgQFAf/EAFwQAAEDAgMEBQQKDQgHBgcAAAECAwQABQYHEQgJEiETMUFRYRQiOHEyQlJ0dXaBs7S1FRYZIzc5YoKFkaGy0zM2V1iUlaKxFyRHcnODxBhDY4SSpSZTVpPU1fD/xAAcAQEAAgMBAQEAAAAAAAAAAAAABQYDBAcCAQj/xAA1EQACAgEBBQUHAwMFAAAAAAAAAQIDBBEFEiExQQYTUWFxMoGRobHB0RQi4SMz8DRDUmKS/9oADAMBAAIRAxEAPwC1OlKUApSukZr5t4ayXwlIxFieemJDb81plPnPSXOxttHtlH9QHMkAE18k1Fat8DJXXO2arrWrfJI7vUfM59uLKnJVx6FMvZxBe29UqtdjCZDiFDsWvUIQdesFXF4GoE7T+3LjjN6P9ibU89hLDUkr1gwnCHpDPsR0rw01CvPBQAE+aBz6zE/hqJsz1/t/Eu+J2ZkuOZLTyX3f4+JNjMjep4/vy3WMHWG14UiE6JfkgzpXgdVcLY79Cg+vvjvizapzfxstxV1zFxApLns2YkxURk+HRs8KdPkrF/DThqPlfZPnItVOzcWhf0619X8T2bnfLpe1E3G4zJ5JCiZTynCSBpr5xPPTlXrxJUmA4XIz7sZZHCVtKKSR3cuzlX5w04aw7xvKCS0O9Ydz+zOwksKtGYGJIIB16JF0eLZ9aCrhPWesVnXL7eZ5w4TdQi9vWzGMMHzk3CIGXgPyXGeAA+KkqqKHDThrLG6cfZkaluBjXrSytP3FtOUO8xyzx+6zCxO1KwHcnNAFTj08MqPZ06QOH1rSkeNS0ttziXmAzNt8pmbCfTxtSI7gcbcSe1KhyI8RWvFw1lPJHaVx/s/3RL+Fr04m3lXE/Z5ersN8a89W/anl7NBCuzXTUVv1ZzXCxFYy+zcJJyxZaPwfL4818y9alR12ZNtHB+0ZHTb06Yexg2gl2ySnQelA5lbC+XSJ05kaBQ56jTzjIqpaE4zW9F8Ci3UW403XbHRoUpSvZgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSldNzVzOsuT2Bbpim/PdHBhI1S0kjjfcPsGkDtUo8vDmTyBNfG1Fas9whO2argtW+CR1/PzP/Dmz7g9d3vbvTzn+JFvtjR++zHQB5o9ykagqUeQHeSAaks3s5cVZ7YwXesSTFSXieCLBZ16CKg6eY0js6hz5lR6ya485M379ndjqdia/PffXjwx4iVEtRGQfNab16gNeZ7SST1mumMqMduRJAJ6BorBSrhKVE8KVD1KUk/JVSysuWTLdj7J3HYuxKtkU97YtbWuL8PJfd9T4N7eRKuTpaIU0jRttSRoFJSNOLTs104vWTXocFc3BTgrxqbji3xZw8FOCubgpwU1Pm4cPBTgrm4KcFNRuHDwU4K5uCnBTUbhw8FOCubgpwU1G4edunS7PPjzoEl2FNjOB1mQwsocaWDqFJUOYII11FWk7E23G3m2IeBscOoj4zQ3wxLidEt3QJHUR7V7TmQOStCRoeVVZ8FcsSQ/b5TMmM85GksLS4080spWhYOoUkjqI011HVWem+VMtYkZtDZlW0KtyfBrk/D/PA2GKVGTYh2pE7QGBFWy9PITjayISiaOSfLGupMlI8TyWByCu4KAqTdWaE1ZFSjyOOZOPZiWyptWjQpSlZDWIabxHbZxVsdfaB9rNjs96+2L7IeUfZYOnovJ/JuHg6Naevp1a669Q8aw+dt/bNA57M5+SzXD+JXVt+d/sT/Tf/QVapQEGdmDeawc1cy0ZZ5mYQkZZ46edEaM1JUsMvyDpowtLiUrZdVr5qVahXVxBRSDmbbf2h71svZEysc2G2wLrcGZ8aII9x4+iKXFEE+YpJ1GnfUI99Vhq34bxXlNji18FuxQ/5ZHclM+a66mOphxleve2pxfPn7NPcKznvTbk9edhBm4SWizJlzbW+62faKV5xHyE6UBibCW8K2sse4ehX/Duz5FvVlmpK40+FbJ7rLoCiklKg7oRqkj5K79kPvTzfMzomXOc+ApGWWJJLyIyJbnStsoeXpwIeZdSHGQokAL1UPOGug1VWb9276EuVvvKR9LfqKO+8w5ak2DK/EIZbbv3lUuCHxoHHI/ChfCe1QSvmOwFxXuqAs7lSmYMZ2RIdQxHaSVuOuKCUoSBqSSeoADXWq5McbzXMTNjMa4YN2Z8tRjNEEqS7e7gw68lwcXD0qW0LbSy3r7Fbq/O1GqU9VZH22s2rxhvdtN3VchbN9xPZbVbn3upWsltsyQQefnNh5PeOLXsr726zytt+XmyJhi5sxUN3bE63rtPfGhU5q6tDI17g0hHLsJV1EmgMEI3jufWz3iS2RdorJ9u3YenL6NN0s7K2XAeslKi64y6pI/7sKQdOZPfY1g/Ftnx9ha1Yjw/OaullukdEuJMZJ4XWljUHvB59R0IOoOhFYx2x8soGbmzLmJh+dHRId+w8ibDKhzblMNqdZUD2HjQAe8FQ7TUZtzJmDLxJs6YgwzLdU8nDl7WmJxHUNx320ucA/5oeV+fQHq7Ue8IzWym2o7hlHgDANnxfIS1HXDZWzIdlyFuR0vKSEtuAHTVXUOoV1uTt47X1mYXOuezQ79j2Bxv9FaLgFBA6zqFK0GnPXQ6dddax9+O1w5/5b6pVVqtARe2NNvLCW13Dm29mC5hfGlub6aXYpD4d42tQkvMuaJ40BSgCCAUkjUaEE9I3hm3NizY/vOCYmGrDZry3fWJTr6rqHiWy0poAJ6NaevpD169lRnxxa4uUW+Sw6cKNpit3mdFdmRImgSlUuMUSdU/lcSnTr2q1A6q5t+L/OrKT3lcv349AZA/7b22d/Vn/wDZ7h/ErLmy3tL7RmaObDFizLyX+0jC64jzy7t9jpbPC6keYjidWU+cezrqZ1KAhPtX7c2LMgtqzLvK2z2GzXC0YlYtzsiZODvTtGROdjq4OFYToEtgjUHmTrqOVTYqpXeTfjI8i/edi+uJVW1UAqE+z3tzYszf2z8wcnLlYbNCseHJF2Zjz4od8pdESWGEcfEsp1IOp0A59WlTYqpXYe/GvZ3+/MS/WaaAtqr0LzeIOHbRNutzlswLbCZXIkypCwhtltCeJS1KPUAATrXv1Cfe6Zhy8D7I0m3QnlMuYmvEa0OlBAV0PC5IWPUfJwk6ditO2gMUXzeW5u56Y3uVh2asqhiK1wFcLl5u8Zx1S06nRwpDjbccK0PCHFKJA10B1A/bJvK838isa22x7SuVCcPWuerhbvNojuNFtOvNwArcbfCe0NqSoDnoToDJrd35XQMrNkTL1qJGbal3y3t36a+kDifclJDqVK9Tam0DuCB261+7xDLKBmhshZhsy46HpNkgLv0J5SdVMOxUl1SknsJbDqD4LVQEhLJeoGJLPBu1rlsz7bNZRJjSo6gpt5taQpK0ntBBB1quPN7eSZy4d2mMW5UYBy2s2LpNqmuR4jLceU9LfQhvjUopQ4AdBqeQHIVlTdFZgy8bbIsa3zHVPLw1eZVnZU4dVdFwtyED1DygpGvUE6dQFRsyb/HR4p9+3T6CqgO4XreRbS2WEcXvMLZ0XAwy0QJEhMOdCSjmNNX19IhHcOJPM1NrZj2nMI7VeXSMU4VW7HUy55PcLXK0EiC/prwK05KBHNKhyI7iCBlS52yJe7bKt0+M1Mgy2lsPx30hSHW1ApUlQPWCCQRVUe5+eVYto7OTDdrcUvDqYalI87jBLMstsniHIngcXz7aAtopSlAKql289oJWbGZa8NWqTxYWw44phvoz5smV1Ou+IHNCevkFEezqd+15m+rJjI693aI90F5mgW22kdYfcB84eKEBa/Wkd9U3Kc1JOupNQO0r2kqo+86Z2P2apyln2Llwj69X9vifteE1bX2McR5wfU6jh06igBXF+0pr8JJr7+HsFX3MR+1WLDVolXq7vyHyiPFRxK04WvOJ9qkdqlaADmSKgoJt8DpeRNRrbk9EdJ4PCvu4PwBiLMG6i24asc++zjzLMCOp0pHerQeaPE6CrA8iN2TbLc3HuuaM83OXyX9gbY6UR0fkuvDRSz4I4QNPZKFTZwpgyxYFtDdrw9Z4VltyPYxoLCWUa9+iRzPieZqapwJz4zehzvO7TY9DcMZb78eS/krCy/3Y+ZuJ0IfxFMtWD46utp9zyqSB38Dfmf4xWfsLbq3AVvbQq/4qv16eT1iGlqG0r80pcV/iqblKk4YVMOmpT7+0G0LnwnuryWnz5/MjVbd3fkVBRo9hSTcTp7KTdZQP+BxIr3vufuQf/wBBf+8T/wCPUh6Vn7ir/ivgRr2lmt699L/0/wAkWLzu2slbohYjW27Wgq10VCua1FPq6UL/AG61ijGG6htTqFrwrjuZFWOaGLxDQ8D4Fxso09fCan9SscsWmXOJs1bZ2hU9Y3N+vH6lOeZOwHnBl0h2Qiwt4ogNgkybA75QoAf+EQlwnTuSR41HmVBegyXY8lhyO+2rhcadSUqQodhB6j662Eqxpmzs84AzthLZxXh6NMlFPC3cWk9FMa5cuF1PnaD3JJT3g1pWbPXOt/EsmJ2qnFqOXDVeK4fL+UUacHhTg8Kk7tcbGy9nAwLrbb8i74ducgxoyJaejlNOBJWEKI8xeqUnmOEk8uHq1jQpsoUUqSUqSdCDyIPdULZCVUt2a4nQcXIpzKldRLVM7dk5mld8lcx7Ni6zHWTAd1cYKtEyWTycaV4KSSOrkdD1gVeHgjGNszBwjaMSWd/ym2XOOiSw528Kh1HuIOoI7CCKoO4PCrHN13m+q44fv+XE57Vy2qNztqVHn0C1APIA7krKVet01I4F27Pu3yZU+0+z1bQsuC/dDn5r+H9yelKUqwnLCqvfnf7E/wBN/wDQV2r7rtjj+rDiD+93/wD9fXVd+d/sT/Tf/QVapQFR8LJ/PDeT59YcxZmdhCRl/ljY+EJiS2HGAtjjC1tMpd0W646QEqd0CQEj3ISZM73VsN7GlwSkBKReYAAA6vPVU16hVvePQ3uXwzB/fVQEVNmHbTz/AMrsgcKYdwps93fF2GLbHdTFvzFrnuNSUF5xalBbbZQQFKUnUH2vrr4OU9kx/vZ8+W75jy62u0YIwh0XlNot6yhTcd1ZV0UdslSit0taLeUdAANNdEoqwndu+hLlb7ykfS36gu+79z13mZWSbflzjRziVz4WGoUxzme4CPIST3htH5fMCR++IYbjbIVvZZbS003iSElCEJASkBmRoAOweFZu2A/Q3yn+Bk/vrrqu82y3mZkbHONG7e0p+dZize22kp4iUMOAvHw0ZU6rl7nTtNfD3VeblszG2TcP2NqU2u+YTW7a58biHGhJcW4wvh6+FTakgHtUhY7KAk3mz+CzGXwNN+YXVdW46/mtm379tvzcippbaGacDJ/ZizDv06SiO87aX7fBSo6KclvtqaZSkdp4lcR06kpUeoGo37mrLmZhbZxvmJprKmRia9Lciaj+UjsIDQWP+Z0w/NoCNG13mlMyW3qSsawMOv4tmWlqG63ZozpbcklVuCOEKCFkaBfFySer5azNJ3tWY05hbFs2Zb4i4ODhYU5cJL6Qvs1bTCSVDwCgfGus4+/Ha4c/8t9Uqq1WgK09iTZWzTzC2kbhtIZ425yx3Za3H7daJbJafU8proUqLKiVNNNNeahC/O1CT7XVXQd+L/OrKT3lcv349W1VUrvxf51ZSe8rl+/HoDIH/ZQ29f6wOH/71l//AINSc2O8rs88sbdidrOzHkDHMqY6wq2OQZTr4jISF9KD0jLWnEVI6ters7ZHUoCpXeTfjI8i/edi+uJVW1VUrvJvxkeRfvOxfXEqraqAVUrsPfjXs7/fmJfrNNW1VUrsPfjXs7/fmJfrNNAW1VXVvtPwB4F+Mw+iv1YrUKt7flxLx5sjS7hBaU89he7Rry4htPEos8Lkdz5EiRxnuCNeygM/7Jvos5N/EyzfQWabWXos5yfEy8/QXqxzu5c3LbmvslYFTElNuXHDsFuwz4wUCthcdPRt8QHUFNJbUD2g+Brk3i+advyu2RMfqlSUNTb7BXYYTJVop9ySOjWlPfo0XFHwSaAwFuS/wB46+Mx+isVFfG2ZWL8o96Fj3E2BsHyceYjjXKYhixxGHnnHkrjcCyEtArPCklXIdnOp07pHLmZgPZEhzpzKmXMTXeTemkrTooMlLbDZ9ShH4x3hYPbUacm/x0eKfft0+gqoD4+0NvMtoiFhb7W7nlevKGZfW3GGbnc4UuNJU3oErMcyAhKSONOq9Dw6jqOhEyt3fsaK2T8ubjLvcyLcsZ4lLT852CvpGIzKAromG1+29mpSlDQEkAahAUeHeg5AjO3ZjulxgRumxDg8qvcMpT562Up0lNjwLWq9BzKmkCvDdebQf+m/Zpt9ruEvp8S4OUmzTeNeq3GAnWK6fAtjg1PMqZWaAmDSlKArU3nuYi7vmNh3BzDmsWzwjMfSD/3755AjtIbQgj/iGoU6isp7VWK14w2iswLipZcCbs7EQrvQx94T8mjYrFBOtUzJl3l0peZ+hNk0LFwKal4LX1fF/NnmV1ZTuto7H+ivFsjomxJN64FO6DjKegbITr3ak6D11WjxVYbup72l20ZiWk6BTL8KUnvPGl1J/VwJ/XWxgNLIXvIntOnLZc9OjX1RPqlKVaziIpSlAKUpQClKUApSlAQg3sjbRyKwq4V6PJxI2lLfekxpHEfk0T+uqxLfegUpYmkqbACUPAaqb06tfdJ05adY5adWhsm3tlzS3lngW3cuN+7uyB6m2Sk/OiqwKgMzR2vU6h2fbhhRkn1f1O1raUjhOoUhQ4krTzCh3j/+8DWXNkrMBeWe0Lgu7FzgivTU2+Xz83oX/vSie8JKgv1pFYLtF3ML7w8C5EWdSkdaD7tPjy5jqI5dYBHYE8bDiHGnCCNFtuoJHqUP86i+NUlJF00hm0zpn1TT960NgClddy9xMnGmAsNYgT1XW2xpw5afyjSV9X51diq5J6rVH59lFwk4y5oh9vA9iK+bZBwGLNiW34d+1zy/pfLmVudN5R5Ppw8PVp0B117xUwaUr6eRWBttPZ1uO1HkfJwLarvFskt6dHliXMbUtADaiSNE89TrWeaUBinZcyemZBZC4RwBcLgxdZlkYcZcmRkFLbpU845qArmPZ6Vi3b02Kk7YeE8OMW66xbBiSxy1rYuEtpTiFRnEaOtEJ581JaUD2cJGnOpUUoDouTmEr/hLKTDeGcY3ONiG+W6AmBMuDKD0csIHAlZCuZKkBPFr1niqEGY262xTgrMaZjTZxzLcy5kzCortEl59lloFXEW0PNBRUzrp97WhQGg5nkBYzSgKz4G7EzfzmxVbZ+0LnOcSWiAsKTbLRJkSStPalCnUNoYKgOaktqJ/aLGMK4VtWCMOWzD9igNWyzWyOiJEhsDRDTSBolI+QdZ5nrNfYpQEPsR7EV8ve3rbM/kYlgNWeJ0XFZ1Mr8oVwQzH5K9j1nX1VMGvQu16t9giKl3OfGt0UEJL8t5LSAfFSiBXVbfnnlvdpSI0HMDC02Sv2LMe9RlrPqAXqaA7zUM9v7YUvu2Jd8GTLNie3YeTYWJTTiZzDjhd6VTZBHD1adGevvqZKFpcQFJIUk8wQddRXnQFav3PXan/AK12IP77un8asp7M+yBnvlLm9asS45z8u2PMORmn0P2OVc577byltKShRS64UHhUQrmOzlU16UBBfbe3fmLdqHO3D2PsNY3g4UctFnj29rpW3enQ81JfeDqFoI4dOmToQdQU61j37nrtT/1rsQf33dP41WVUoCL+x1s45sZE3LFD+ZOblxzNYuTUdEJqdOlyREUgrK1Dp1q04uJI5aa8POo24x3XWaz+emOcxMFZxs4LlYivE+4NuWsyoslpmTIU90SnGlJJ606gHQlNWZUoCtX7nrtT/wBa7EH993T+NUy9nvKLEeXuR0XBOZGKHMyLqrypufc7k67J8rZdWr72svFSlJCFcGhJGnLqrL9KArZxTuucf5WY5uGI9m/Nh3BDE4+fablJkMpbTqSGy80lfTIBJ4Q42SO1SjzrxwzuvMx81sc22/7R2bS8aQ7erVNotsqQ+l1GupbDrqW+hQrQcQbb1PPQg+dVlFKA9K0WqHYbVDtlujNQYENlEeNGYSEoabQkJQhI7AAAAO6ogYI2Fb7hTbru+fTuJrc/aZr8t1NoQwsPp6aOWhqr2PInWpmUoDieaRIaW24hLjaxwqQoahQPWCO2oVbK2wTiTZW2iMTYssWLre/l/ehIYOHyy4H22CsuRhxexK2jonXlqkq79Km1SgFKUoCgjEd1N6xBc7iTqZcp1/UjTXiUVa/tr5nFXJLYXClPMO/yjS1Nq0Oo1HL/ADFeuV91UbQ/SKaSSXI8ye+pbbszGaLFn/Jsjrmjd9tTzLSdet5opeH+BD1REJ1rtuUWPXcr8zsMYqZClfYqe1JcQnrW0D98T+cgqT8tZ6Z93ZGXgRu0aP1WJZT1knp69PmXx0r1YM6Pc4UeZFdRIiyG0utOoOqVoUNQR4EGvaq5HABSlKAUpSgFKUoBSlKArD3s+Kkz8xcD4bS4FG22x6cpI9qZDgTz+SMDp2Dn21AsprOW2XmGjM/aRxpdmHA5BjyvsdFUk6gtxx0XED2hSkqV+dWEiKrN09+yTR2LZ2O6MOqD56fXievX2rJdw2kQ5J+8k/enD1tK7v8AdPd2HmO0H5RTXGRpWFpSWjJGMnXJSjzL0NkSU7M2a8v1PpWhxu3BgpcGhAbWpA/YkfJWYqwRsONPMbKWXKX+azAWoaq180vOFP8AhIrO9Wer+3FeSOM5r1yrX/2f1KgN95+FPLX4GkfP1WtVlO+8/Cnlr8DSPn6rWrKaRtUUpSgFRU3o/oK5mfoz6ziVKuoqb0f0FczP0Z9ZxKAoCq9PdD+hvbfhmd++mqLKvT3Q/ob234ZnfvpoCatV47wXeVuZH3OXlzlg5Hl42aHDc706hLrNrJAIabSdUuPaHU8QKUdRBVqEyu2s87Rs8bPuMsdI4FXCBE6O3tucwuW6oNM6jtAWtKiPcpPVWuFc7nLvdylXC4SXZk6W6t9+Q8oqW64olSlKJ6ySSSaA+1jzMjFWaN9cvOL8Q3LEd0XrrJuMhTygDz4U8R81PgNAOwV1qp5bujd72/aagT8dY9emRsExJBhw4MNfRu3J5IBcJX1paRqkap5qUSARwHWwPFO632csR2BdtjYIdw+/wcLVxtl0k+UNeP31xaVH/fSqgKcchNrzNTZwujD+DsUym7ahQU7Y5qy/b3x2gsqOiSfdI4VflCrxtkDa4wztcZd/Zu1JFsxBA4GbzZFr4lxHSOSkn27S9FFKtOwg6EEVRntWbON42Wc5Lrge6yPL46EJl265BHAJsRevA5w6nhOqVJUOeikK0JGhPYNhjP6Vs7bSGFb+ZSo9hnSE2u9NlWiFw3lBKlqH/hq4XR4t6dpoDYnqgHej+nVmZ+jPqyJV/wBVAO9H9OrMz9GfVkSgMf7FHpb5Q/GaD86mtj6tcHYo9LfKH4zQfnU1sfUBH/b89DfNj4GV++itdetijb89DfNj4GV++itdegLqdyp6LOKfjnK+gwa+rvkvRHh/GaF8zIr5W5U9FnFPxzlfQYNfV3yXojw/jNC+ZkUBSDWwnu3fQlyt95SPpb9a9lbCe7d9CXK33lI+lv0BGrfefgsy0+GZPzAqoGrft95+CzLT4Zk/MCqgaA/QSk6g6HwrKWWm1Hm1k/Nak4TzBvtrDZ4hFMtT0VR/KYc4m1fKk1aJkXutsjMxMisvcT3WHfRd77hu33KW7HuhSnpnorbiylPCQBxKOg5gVHjbY3V/+gvBE7H2W94n37DltT0tztd14FS4rXa+hxCUhxCdfOHCFJHPVQB0AkvsN70G357XaDgTMhiHh7G0jRuDcmDwQ7mvsb4T/JPHsGpSo8hoSEmwGtVyPIcivtvMuKadbUFoWg6KSRzBB7DWwTu9tpB/aU2c7Td7tI6fFNmcNovCyfOdebSCh4/8RtSFE6AcXGB1UBV7nbYFYTzjxvZ1JKBCvUxlA5c0B5fCfURoeyuklVSe3jWBF4P2krjcUo4YmIYbFxbI6gsJ6JweviaKvz6i6TVOuhuWSj5nfcHIWRi12rql9DyKq/Cda8CvurxJNY9Da3i3Hd4ZzozLyNj2CXI6S94UKbe6lR85UY6mOr1cILf/ACvGpU1SPsoZ9PbPmcNtvzilqsUr/UbuwjnxxlkarA7VIUErHaeEp1Gpq623T412gx5sN9uVEktpeZfaVxIcQoapUk9oIIOtWfDt7yvR80cd2/g/pMtziv2z4r16r4nt0pSt4rQpSlAKUpQCsTbUObjeSWSOJcTpdDdySwYttTy1VLd81sgdvCSVke5Qqss1VbvJs+hmBmPHwJapAcsmGVEylNnUOzzyX6w2PM8FFzr5Vq5Nvc1t9ehM7IwXn5ca2v2ri/RfnkQvc1WoqUdVE6knmSa4ymvYKa8CnWqxqdkcT1imvApr2Cmu25PYBdzPzVwphVtKiLtcWYzpT1oaKvvq/wA1AUr5K9ri9DWsahFzlyXEuy2dsNqwjkTl9Z3EdG9FsUNLyNNNHSykuf4iqsjV4IQlptKEJCUJGgSBoAK86tqWiSOHTk5zc31epUBvvPwp5a/A0j5+q1qsp33n4U8tfgaR8/Va1fTwbVFKUoBUVN6P6CuZn6M+s4lSrqKm9H9BXMz9GfWcSgKAqvT3Q/ob234Znfvpqiyr090P6G9t+GZ376aA6Jvq8UPW7IHBtjbUUN3PEIfdI9slmO5on1cTiT+aPlpnq2jfi/zWyk9+3L5uPVS9AbF+wnhCPgnZAyngRkJQmRYY9zVw9q5SfKVH16ums81inZN9FnJv4mWb6CzWVqAqy34GEWDByqxQhtKZSXZ1tec7VoIacbHqBDv/AKjVUlW/b7z8FmWnwzJ+YFVA0Bs0bP2KXccZEZc4hkudLJuuHLdNeXrqS45GbUvXx4iapB3o/p1Zmfoz6siVcnsU+iPlB8WYPzKaps3o/p1Zmfoz6siUBj/Yo9LfKH4zQfnU1sfVrg7FHpb5Q/GaD86mtj6gI/7fnob5sfAyv30Vrr1sUbfnob5sfAyv30Vrr0BdTuVPRZxT8c5X0GDX1d8l6I8P4zQvmZFfK3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrIOKMOwsX4Zu9iuLfS2+6RHYUls+2bcQULH6lGsfbJvos5N/EyzfQWaytQGrBcIK7bPkxHSlTjDqmlFPUSkkHTw5VZbuQ8XyI+O8zMLFalRZdti3MI9qlbTqmyfAkPj18I7qryzSaQzmbi5ptCW20XeWlCEjQJAeXoB3DSprblT0psU/EyV9Og0BODeaZTKxjk/BxhCYLlwwvI4nikecYjxCXPXwrDSvAcRqq0nvrYIxDYYOKbDcbNdI6ZduuEdyLJYX1ONrSUqSfWCaozz5yhuWReaV7wjcQtYiO8USSpOgkxlc2nB6xyOnUoKHZUFn1aSVi6nSuzGcp0yxJPjHivR/z9ToRVXiVV414lVRWhdnI8tTVh+7j2r0BuNlLiuYEqB/+H5jyuvXmYhPf1lHyp9yKrsKq/WZDkZ5DzTi2nW1BSHEEhSVA8iD2HXtFbFNjplvRIvPxK8+h02e5+D8TYjpUMNiHbfYzfixcEY3lNxsbsI4Ys1eiUXVAH6g8ANSn23WO0CZ9WauyNsd6Jx7KxbcO11WrRr5+aFKUrIagpSsc54524fyFwJKxLf3Cvh+9xILagHZjx9i2jX9ZPUBqefVXmUlFb0uRkrrndNV1rWT5Ix/tl7SkfZ+y3dRAeQrGN3Qpi1R+stctFyFDuQDy161cI0I4tKc5Lzsp9x59xbzziitbjiipSlE8yT2nt1Nd3zezUv2dWO7hirEMjpZkk8LbIJ6OMyD5jTY7Ep1+Ukk6kknpJGtVbJyHfPVclyO1bI2VHZmPuvjOXN/b3HrlOlcZTXslNcak1rJkw4nrkVODda5SLvmY16zAlM/6jYo5hQ3D2ynk6K0/3WuIH/iioYWiyzcQ3eFardHXMuM15EePHbGqnXVq4UpHiSQKvA2c8nIuRGUNiwkz0bkthvpp8hvqflL5ur8Rr5o/JSmpLCq7yzefJFP7R5axsXuU/wB0+Hu6/gyfSlKsRykqA33n4U8tfgaR8/Va1WU77z8KeWvwNI+fqtagNqilKUAqKm9H9BXMz9GfWcSpV1FTej+grmZ+jPrOJQFAVXp7of0N7b8Mzv301RZV6e6H9De2/DM799NAYZ34UZxWDcp5ARqyifcG1K7lKbYIH+FX6qqSq7DfLYHexDsw2m/x2uNWH7+w8+vT2DDzbjJP/wBxTAqk+gNlLZN9FnJv4mWb6CzWVqjPu48xouZOx5l88w8lyTZon2Clt8WqmXIx6NKT3atBpYHctNSYoCtXfefgsy0+GZPzAqoGrPN9vmPEn4qy2wNGeC5VtjSrrNbSrUJ6ZTbbIPcdGXT6lDv51kR47kp9tlltTrrighCEDVSieQAHaaA2Odi1tTWyVlClSSlX2sQFaHuLKSD+o61TXvR/TqzM/Rn1ZEq9HKTCCsvsqcGYWWAFWOywrYQDxAFlhDfX2+x66o13p0N2Nty5huOJ0RIbtrrZ70/Y6Mj/ADQoUBjjYo9LfKH4zQfnU1sfVrd7GsxmDtYZQvPuBpsYot6eI9QKn0JH7SBWyJQEf9vz0N82PgZX76K1162F94rd27JsW5pyHdOFy3tRhqrTznZDTQ/ascv8q16KAup3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMivS3L8B2HspX11waIlYtlvNnvSIsRH+aFV7u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrK1Yp2TfRZyb+Jlm+gs12TOHMaDlFlZivGdycQ3DsduemnjOnGpKTwIHipXCkDtKhQGtbmPMRcsw8US2goNSLpKdSFciAp5RAPjzqb+5VZcVtP4rdCSWk4OkoK+wEzYRA/Yf1VAB11ch1bjq1OOLPEpajqST1kmrTNyFl490+ZuOnmuGPwxrLFd09mrm8+nw0Hk58eLwoC1iou7dOy7/p8wAm72KOlWNrE2pcMDQGazrquOT39aka+21HLjJqUVKxzgrIuMjZxsizFtjdU+KNd19pyM8408hTTqFFK21p0UlQPMEdhrj1FWW7eGw6vFqp+ZOXsLivYBeu9kjp5zABzfZA63fdI9v1jztQqs5WoJB1BHLSq1bTKmW7I69g59WfUrK+fVeDPIqrx4q8eKvEqrFob28czEl2I+2+w6tl9pQWhxtRSpCgdQQew689RViWyfvJG+hh4UzcklK06NRcU8OoV3CUB1Hs6QdfLiA5qNcpVXjxVsVWSqlrEjczDpzq9y1ej6r0Nie33GLdoLEyFJamQ5CA40+wsLbcSeYUlQ5EEdor26o82dtqnMvIi4JjYXnG52Qq437FcNXYhB5FQ5joTqR5ySka6cWoGlSxzF3nFzueEI0XCOG0WTEL7X+tzJbyZLcRfaGRwgOH8pQ0HuVddSv66pR1nwZSH2azZWqFC3ovry09f41JZbQO0xhLZ7sJkXiR5be32yYVkjKHTvnmOI+4RqPZHuOmp5VUtnPnPibPPGL2IMSy+kcOqY0NokMRG9fYNp7B3nrJ5kk113EeILni69S7veZ79zuktZcflSVla1nxJ8OWnUByHKvlEd9QWTmSyHpyj4HS9kbBp2VHe9qx839l4fVnrlNcZTXslNeBTWnqT7iespOlcZTXslNS92K9il7NmZFxrjOMuPgtlfHFhLHCq6KB/WGQRzPtuodpGequV0t2BFZuVTg0u656JfPyRkjdybLS4QazZxPE4XXEKTYIjydCEEaKlEeI1SjXsKlac0mrBa4WGG4rKGWUJbaQkJShA0SkDqAHdXNVtpqjTBQicOz82zaF7vs68l4LwFKUrMR5UBvvPwp5a/A0j5+q1qt93rOy7mjn9mDga4YAwjJxJDt9reYkusPsthtZd4gD0i09ndUFvub20j/RbcP7bE/jUBKr7uLfP6JLf/AH4v+BT7uLfP6JLf/fi/4FRV+5vbSP8ARbcP7bE/jU+5vbSP9Ftw/tsT+NQFgmynvUrptIZ+YWy6kZdw7EzevKuKe1dVvKa6GK8+PMLSddei4esdevhWZd6P6CuZn6M+s4lQb2AtifOzKLa2wJizF+AZllw9b/L/ACmc7JjrS30kCQ0jkhwk6rWkch21YTt+5b4kzc2SMd4TwjanL1iG4eQeSwWlpQp3o58d1fNZAGiEKPMjqoDXdq9PdD+hvbfhmd++mqwPub20j/RbcP7bE/jVbbu2spcW5KbMkHDONbK7Yb43dJb6obziFqCFqBSrVClDnp30BnPOXK+2Z05V4owPeOUC+QXIinAniLSyNW3QPdIWErHikVrb5p5Z3/JzMG+YOxPDVBvVokKjvtkHhXp7FxBPskLSQpJ7UkHtrZ8qM+2LsLYM2ubM1ImOHD+NILJbgYgjNBauHrDT6OXSt6nUDUFJJ4SNSCBTzsf7bGMNkDEM120Rmr/hm5FKrhYJbpbbdUnkHG1gHo3NOXFoQR1pOg0mrijfe2/7X3BhzK6SL4tGiDdLmkxmld54EcTg8PN17xUTc092Pn/lnPdQzg9WL7cFEN3DDbokpc/5XJ1Pyo08TWIbpsw5wWOzz7rdMq8Z2u2QGVSJUydYJTDTLafZKUpbYAA6yewc+ygOvZrZo4izozAvWM8VTjcL5dXumfd00SkABKUIT7VCUhKUjsAFST3ZWzLMz42g7Xfp0NasH4Pfauk99SfMdkJPFGYHeVLSFEe4QrXTUaw+q3zdV7Y2X72C7RkvOtUDBeKGVkwpDOoYvrqvZLUpRJEk6AEKOigEhGgAQALLKqS30uRsuHivCebECKpdumxhY7m6gcmn2ypbC1f76FLTr1DoR3jW22uu4/wDYM0sG3bCuKLY1drDdGTHlRHtdFpPPUEc0qBAIUCCCAQQQKA1grfPk2qdHmxHlxpcdxLzLzZ4VNrSQUqB7CDodatHyx32Rg4XhxMeZfP3K+MNBD1ys01DbcpQ9uWVI+9k9ZAURr1ADkMf7RG55zAwjd5U/KiSxjXD61FTVtmSG41xjp9ySspbdA90Ckn3PfFK7bG2e1klGPIygxq4sdsOxyJKP/U0hSf20BmjbZ3j192ssPRMJW3D6cI4PZkJlvx1SzIkzXU68HSKCUpShPFrwAHzgCVHQAQ7ixXp0pqPHaW/IdUG22mklSlqJ0AAHWSeWgrP+B937tB49lNswcrr3bkq63r42LchA7z05QfkAJ8DVk+xJuurVkHfIWN8w5kPFONI33yDBjIKoNtc/wDmAqALro7FEAJPMAkBQAkVsWZKv5AbM+CcHz2w3eGYqpdyA6xKfWp1xBPaUFfBr3IFYG3yXojw/jNC+ZkVOqoj7zjJ3GWeOzjGw5gaxvYhvSb9GlmIy42hQaS28FK1WpI5FSe3toCg+thPdu+hLlb7ykfS36qA+5vbSP8ARbcP7bE/jVc9sPYBxBlbsr4Awrim2uWe/wBtivNyoTi0qU0TJdWBqkkHzVJPInroCJe+8/BZlp8MyfmBVQNXfb1nILH+fuX2BbfgDDb+JJlvubz8lph5pvo0Ka4QT0ik9vdVav3N7aR/otuH9tifxqAkDllvib1llldhPB0fLKBOGH7NEtDU127rT0vQMoaDikBrlrwa6BXhr21H/aj2+8ztqqG3aL89DsWFWnQ8mx2ZCkNOrHsVPKUpSnCOwEhIPMJB51+p3bm0itQSMrZ4JPWqdDA+erKWWe58zwxdMa+2j7C4Eg8Q6VcyaiZICe9DccrSo+CnE+ugIbYFwRfMysXWrC+Grc9db7dHxHiQ2BqpxZ/YABqSToAASdADWxRsoZAQtmXIvDmBoy25E2M2ZNzmNg6SZjminVjt4ddEp158KE611XZR2HMvdky2rdsbLl6xXJa6KZiO4IHTrTrqUNJHJpH5KdSdBxKVoNJF0ApSlAKhptb7vu0ZxuzMV4HMewY0Xq5IjL82JcVdpVp/Jun3Y5KPshzKhMulY51xsjuyRtY2VbiWKyl6P/OZr343wBiPLfEj9gxPZpdmvDJ0VFkt6KI7FJPUtJ7FJ1B7zXot4YurjoaXCXHUocQ8q0YBHrXprV+GY2VuF82LA7ZsVWhm6wljzePVLjR70LSQpB8QR8tQpzN3X7yVPSsAYpStPMpt19ToQO4PNj/NHy9tQt2JbDjWtUdF2dt3DyFu5cu7l6ar49PeveV2sYVcUgLflssni4VNJ1WsDXrGg4T3+yr6DFitsbrQ7NVqRxPK4EkacvNTzB/OI8KyxmDs05m5Xl1V/wAH3FmIgnWdFb8pjad5cb4kp79FaHwrGVQ052RekloX7HoxbY79UlNeKeq+R5qeUW+jGjbWvF0TaQhAOgGvCOQOg6+2vClK1ufMlElFaJCvwjWv2uy4My0xZmHJEfDWHbnfHOLhJhRlOIQfylAaJHidBX1JyeiPM5xrjvTei8zqxTpXPbbRMvlwjwLdEfnTpCw2zGjNlxxxR6glI5k+AqZGVO7SxfiFTMvHN0j4WgnmuFFIlSz4aj72j16q9VTfye2csBZGxAnC9jbbnqRwO3WV9+mOjt1cI5A8vNQEp8KlacC2zjL9qKZtHtRg4qcaH3kvLl8fxqRM2X93apl6JibNVhCtNHY2GQriGuvIyVDkR29GNfyj1pqfseO1EYbZZbQ0y2kIQ2gAJSAOQA7B4Vz0qx00QojuwRybP2jkbSt7y+Xoui9BSlKzkYKUpQClKUApSlAKUpQClKUApSlAK43G0PtqQtIWhQKSlQ1BFclKAqf3hO7HXbjdMzMnrYXIhK5V3wpFTzZGmqnoiR1p6yWRzHtBp5ohvsh7HuM9q/HCYVjC7Rh2CtKrniR1tRZiDrCUdXG8exAI7yQOdbFFfKsOGrRhWI7Estsh2mK6+5JWzBYSyhbriipxZCQNVKUSSesmgPHClg+1bDNqs/2Qm3XyCM3F8uuTvSyZHAkJ6R1eg4lnTUntPOvr0pQClKUApSlAKUpQClKUApSlAKUpQClKUApSlAKUpQClKUArGebWWWD8Q4fnz7rhOx3OcACJMy3Muug6jnxKSTSlaeV7BObG/wBUirPPOxW20vSPIbfFh6ON6eTsJb08zwFY+wDGZmXwIkNIfRwK81xIUOrxpSqjL2zvVf8AZ934LPNmnKTA0y0KmSMGYefltrHA+5amFOJ5HqUUaipJxI7UOK2yw2hhpCdEttpCUj1AUpVowvZOMdo/76PapSlSRUBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoD//ZCmVuZHN0cmVhbQplbmRvYmoKMSAwIG9iago8PC9Db250ZW50cyAyIDAgUi9UeXBlL1BhZ2UvUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldL0ZvbnQ8PC9GMSAzIDAgUi9GMiA0IDAgUi9GMyA1IDAgUj4+L1hPYmplY3Q8PC9pbWcwIDYgMCBSPj4+Pi9QYXJlbnQgNyAwIFIvTWVkaWFCb3hbMCAwIDU5NS4wMSA4NDEuOTldPj4KZW5kb2JqCjcgMCBvYmoKPDwvS2lkc1sxIDAgUl0vVHlwZS9QYWdlcy9Db3VudCAxL0lUWFQoMi4xLjcpPj4KZW5kb2JqCjggMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDcgMCBSPj4KZW5kb2JqCjkgMCBvYmoKPDwvTW9kRGF0ZShEOjIwMjIwMjI0MTg1NjQyWikvQ3JlYXRpb25EYXRlKEQ6MjAyMjAyMjQxODU2NDJaKS9Qcm9kdWNlcihpVGV4dCAyLjEuNyBieSAxVDNYVCk+PgplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAxNTQzMiAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE2MTcgMDAwMDAgbiAKMDAwMDAwMTcwNSAwMDAwMCBuIAowMDAwMDAxNzk1IDAwMDAwIG4gCjAwMDAwMDE4ODQgMDAwMDAgbiAKMDAwMDAxNTYzMSAwMDAwMCBuIAowMDAwMDE1Njk0IDAwMDAwIG4gCjAwMDAwMTU3MzkgMDAwMDAgbiAKdHJhaWxlcgo8PC9JbmZvIDkgMCBSL0lEIFs8MTRmMjhmN2Q5NDdhOTM0MzNiN2QzZWNiZWZlNDRiNjc+PDZhMDJkZTJjODNiZGQyMjViODE4NjE2OTE5NTdiZmI3Pl0vUm9vdCA4IDAgUi9TaXplIDEwPj4Kc3RhcnR4cmVmCjE1ODQ5CiUlRU9GCg==\"\n },\n \"messages\": [\n \"PDF created\"\n ],\n \"total\": 1\n}"},{"id":"a728cf55-c594-4319-bd79-1dc34f0a9fa9","name":"Order PDF by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/orders/:lookupKey/:lookupId/pdf","host":["https://api.helice.cloud/api/g/v1"],"path":["orders",":lookupKey",":lookupId","pdf"],"variable":[{"key":"lookupKey","value":"id","description":"Use `id` or `externalId`\n\n`id` - Integer"},{"key":"lookupId","value":"395","description":"The `id` or `externalId` of the order \n\n`id` - Integer, `externalId` - String"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"text/html;charset=UTF-8"},{"key":"content-length","value":"0"},{"key":"date","value":"Wed, 23 Mar 2022 15:37:05 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c5d4a18d-97a2-4285-8489-caf58535cb4e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/15001\",\n \"messages\": [\n \"Order with id [395] not found\"\n ],\n \"status\": 404,\n \"code\": 15001,\n \"type\": \"OrderNotFound\"\n }\n}"}],"_postman_id":"71b81505-2f2d-41ab-9233-53ccc151e872"}],"id":"5d81a914-91e7-40fa-8d84-8582030a6bcb","description":"

Order API exposes endpoints for creating, updating and searching orders. Additionally, endpoints for processing orders and managing order shipments are available.

Fields

An order resource contains the fields below:

fields available when creating an order via the API are marked in the Create via POST column.
a smaller subset of these fields is updatable using the API, these are marked in the Update via Patch column.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Get order (GET)	Create order (POST)	Update order (PATCH)
id	`order` id	integer	x
shop	`shop` identifier	JSON object	x
status	`order` status	string	x	x	x
channelId	`channel` id	integer	x	x
shopId	`shop` id	integer	x
source	external system	string		x	x
sourceId	external system unique id	string		x	x
userId	customer `user` id of	integer	x
debtorId	customer debtor Id	string	x	x
firstName	customer first name	string	x	x
middleName	customer middle name	string	x	x
lastName	customer last name	string	x	x
email	customer email	string	x	x
type	`order` type	enum dropshipment stock purchase quotation	x
remarks	`order` remarks	string	x	x
reference	`order` reference (e.g. po number)	string	x	x
extraInfo	`order` extra info	string	x	x
language	locale in which the `order` was created (e.g. EN-US)	string ISO 639-1	x	x	x
date	order date	date	x	x
orderSource	`order` was create via which medium (webshop / backoffice / API)	string	x	x	x
externalId (deprecated)	external `order` id	string	x		x
itemCount	total number of `orderItems`	integer	x
exportDate	`order` export date	date		x	x
exportStatus	`order` export status	enum EXPORTED FAILED		x	x
exportMessage	`order` export message (e.g. a success or failed message)	string		x	x
merchantCost	costs calculated by a marketplace (e.g. Amazon)	integer	x	x
accountingId	identifier for accounting purposes	string	x	x
trackTraceCode	Track and trace codes of the `order`	string		x
paymentData		JSON object (paymentData)	x
total	object containing various calculation of summed items	JSON object (total)	x	x
postageData		JSON object (postageData)	x	x	x
clientData	`user` / `contact` or `customer` object	JSON object	x	x
invoiceData	invoice `address`	JSON object	x	x
shippingData	shipment `address`	JSON object	x	x
items	order items	array (items)	x

Payment data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Get order (GET)	Create order (POST)
payMethod	method of payment, e.g. creditcard, on account, direct debit. The value should match the paymethod configured in the Propeller backoffice	string	x	x
grossAmount	cost of the payment excluding VAT (e.g. creditcard transaction costs)	integer	x	x
netAmount	cost of payment including VAT	integer	x
payStatus	status of the payment	string	x	x
payStatusDate	date of payment processing	date	x
transactionId	Identifier of the transaction, often this is an id returned by the payment service provider	string	x	x

Total

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Get order (GET)	Create order (POST)
discountPercentage	discount percentage on the total `order` amount	integer	x	x
discountValue	discount amount on the total `order` amount	integer	x	x
totalNet	total `order` amount including VAT	integer	x
totalGross	total `order` amount excluding VAT	integer	x
tax	total VAT amounts per Tax percentage of the combined order items	JSON object	x

Postage data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Get order (GET)	Create order (POST)	Update order (PATCH)
requestDate	`order` requested delivery date	date	x	x	x
shippingMethod	method of shipment, e.g. regular, dropshipment, pickup, etc. The value should match the shippingmethods configured in the Propeller backoffice	string	x	x
postageTaxCode	postage/shipping costs tax code	enum `H` = High `L` = Low `N` = None		x
postageTaxPercentage	postage/shipping cost tax percentage	integer	x
postage	postage/shipping costs excluding VAT	integer	x	x
postageNet	postage/shipping costs including VAT	integer	x
partialDeliveryAllowed	is partial delivery of the order allowed	enum `Y` = Yes `N` = No	x	x
carrier		string	x
pickUpLocationId		integer	x

Client data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Get order (GET)	Create order (POST)
user resource	all fields related to a `user` / `contact` / `customer` resource	user	x
contact	a reference by lookup key to an existing `contact` resource	JSON object		x
customer	a reference by lookup key to an existing `customer` resource	JSON object		x
user	a reference by lookup key to an existing `user` resource	JSON object		x

Invoice data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Get order (GET)	Create order (POST)	Update order (PATCH)
address	invoice address	JSON object (address)	x	x

Shipping data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Get order (GET)	Create order (POST)	Update order (PATCH)
address	shipping address	JSON object (address)	x	x

Items

Name	Description	Type	Get order (GET)	Create order (POST)
type	`orderItem` type	enum product	x	x
`product` resource	all fields related to a `product` resource	product	x
childItems	`product` child items	array[products]	x
name	`orderItem` name	string		x
quantity	`orderItem` quantity	integer		x
price	`orderItem` price	number		x
originalPrice	`product` default price	number	x
notes	`orderItem` notes	string		x
sku	`product` sku used for product lookup	string		x
supplier	`product` supplier used for product lookup	string		x
supplierCode	`product` suppliercode used for product lookup	string		x
source	`product` source used for product lookup	string		x
sourceId	`product` sourceId used for product lookup	string		x
turnoverGroup	identifier for accounting purposes	string		x
discountAmount	sum of all item incentives applied by business rules	number	x
discountAmountTotal	discountAmount * quantity	number	x
discountPercentage	discountAmount percentage of the item price	number	x
discountAmountNet	discountAmount + tax	number	x
discountAmountTotalNet	discountAmount * quantity + tax	number	x

Order Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

identifier	Description	Type
id	Propellor `order`id	integer
sourceId	External system unique id. `sourceId` should be combined with `source`	string
externalId (deprecated)	id of an external system which is stored as externalId in the Propellor `order`	string

What are lookup keys?

Expanding resources

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query parameter	Description
orderItems	Expand `orderItems` in the response payload
orderItems.product	Expand `product` details as part of the `orderItems` in the response payload
sources	Expand `sources` in the response payload

Order Errors

This section describes error codes specific for the Order resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
15001	OrderNotFound	404	Order does not exist	Order with such lookup key not found
15002	OrderNotProcessed	400	Order not processed	Order was not processed successfully
15003	ParentOrderNotFound	404	Parent order does not exist	Parent order with such lookup key not found. This error is typical when working with order sub-resources (e.g. addresses)
90006	AddressNotFound	404	Address does not exist	Order address does not exist
15004	OrderExists	400	Order already exists	When creating / updating an order the `sourceId / source` combination already exists in Propeller.

","_postman_id":"5d81a914-91e7-40fa-8d84-8582030a6bcb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Inventory","item":[{"name":"Product Inventory","item":[{"name":"Get Product Inventory","id":"e1765432-ebf7-4d54-9524-6e14d7577b4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory","description":"

This endpoint gives cumulative product inventory data by searching on a lookup key.

Expands cumulative inventory data with detailed records

\n","type":"text/plain"},"key":"expands","value":"inventoryBalance"}],"variable":[{"description":{"content":"

Available lookup keys: id, sourceId, sku, supplierCode

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupkey"},{"description":{"content":"

Lookup key value

\n","type":"text/plain"},"type":"any","value":"38952","key":"key"}]}},"response":[{"id":"c1f736f5-fe1a-4ef0-a125-350f87830b60","name":"Get Product Inventory by id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records","disabled":true}],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"159"},{"key":"date","value":"Thu, 24 Mar 2022 09:29:07 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"df58a019-d024-463e-9b1c-9329033926e7"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"localQuantity\": 136,\n \"totalQuantity\": 190,\n \"supplierQuantity\": 54,\n \"localReservedQuantity\": 0,\n \"totalReservedQuantity\": 0,\n \"supplierReservedQuantity\": 0,\n \"productId\": 38952\n }\n ],\n \"messages\": [],\n \"total\": 1\n}"},{"id":"5e9dad7d-6150-4727-ad9e-1a7e79e6d1ce","name":"Get Product Inventory by id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records","disabled":true}],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"59328","description":"Lookup key value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Thu, 24 Mar 2022 09:29:47 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"fb39c0b4-ff29-4330-8e2c-09c060175882"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [59328] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"},{"id":"d7d627db-7f12-4b28-ae65-301bf25902bb","name":"Get Product Inventory By ID - expands - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory?expands=inventoryBalance","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records"}],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"4322"},{"key":"date","value":"Wed, 09 Mar 2022 14:31:14 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"eff94aa2-07fe-4c7d-adba-8574a2fbf96e"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"localQuantity\": 133,\n \"totalQuantity\": 171,\n \"balance\": [\n {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"dateModified\": \"2022-03-09T10:49:54\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16150,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"dateModified\": \"2022-02-21T12:55:27\",\n \"notes\": \"\",\n \"location\": \"L5\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16152,\n \"warehouseId\": 4,\n \"quantity\": 3,\n \"costPrice\": 11.31,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T10:59:59\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16157,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-03-09T10:46:25\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16159,\n \"warehouseId\": 0,\n \"quantity\": 5,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T22:05:16\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16160,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2022-02-16T22:05:17\",\n \"notes\": \"\",\n \"location\": \"L5\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16162,\n \"warehouseId\": 4,\n \"quantity\": 16,\n \"costPrice\": 11.31,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T22:12:18\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16164,\n \"warehouseId\": 0,\n \"quantity\": 5,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T22:12:19\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16165,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T22:17:44\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16168,\n \"warehouseId\": 0,\n \"quantity\": 5,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T22:17:44\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16169,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T22:21:27\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16172,\n \"warehouseId\": 0,\n \"quantity\": 5,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-16T22:21:28\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16173,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-17T00:03:24\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16176,\n \"warehouseId\": 0,\n \"quantity\": 5,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-17T00:03:24\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16177,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-17T00:05:35\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16180,\n \"warehouseId\": 0,\n \"quantity\": 5,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-17T00:05:35\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16181,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-17T00:18:15\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16184,\n \"warehouseId\": 0,\n \"quantity\": 5,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-02-17T00:18:15\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16185,\n \"warehouseId\": 0,\n \"quantity\": 13,\n \"costPrice\": 0,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n }\n ],\n \"supplierQuantity\": 38,\n \"localReservedQuantity\": 0,\n \"totalReservedQuantity\": 0,\n \"supplierReservedQuantity\": 0,\n \"productId\": 38952\n }\n ],\n \"messages\": [],\n \"total\": 1\n}"},{"id":"2d73eab2-8bef-4954-93a1-056d3768d371","name":"Get Product Inventory by id - 200 (reserved stock)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records","disabled":true}],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"227237","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"255"},{"key":"Date","value":"Mon, 02 Oct 2023 14:22:50 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"supplierReservedQuantity\": 164,\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"localQuantity\": 0,\n \"totalQuantity\": 262,\n \"supplierQuantity\": 246,\n \"localReservedQuantity\": 0,\n \"productId\": 227237,\n \"totalReservedQuantity\": 164\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 1\n}"},{"id":"badb2923-8bd7-4dad-99cf-c8014d4553d7","name":"Get Product Inventory by id - expands - 200 (reserved stock)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory?expands=inventoryBalance","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records"}],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"227237","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"1384"},{"key":"Date","value":"Mon, 02 Oct 2023 14:24:00 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"supplierReservedQuantity\": 164,\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"localQuantity\": 0,\n \"totalQuantity\": 262,\n \"balance\": [\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2023-09-29T17:54:11\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 227583,\n \"id\": 16139,\n \"warehouseId\": 0,\n \"quantity\": 87,\n \"costPrice\": 400.95,\n \"productId\": 227237,\n \"supplier\": \"TECHDATA\"\n },\n {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2023-09-28T19:56:35\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"L5\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 0,\n \"id\": 16140,\n \"warehouseId\": 0,\n \"quantity\": 16,\n \"costPrice\": 11.31,\n \"productId\": 227237,\n \"supplier\": \"KERRIDGE\"\n },\n {\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"dateModified\": \"2023-09-29T17:54:11\",\n \"notes\": \"\",\n \"usergroupId\": 143,\n \"location\": \"B45\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 0,\n \"id\": 16141,\n \"warehouseId\": 0,\n \"quantity\": 77,\n \"costPrice\": 400.95,\n \"productId\": 227237,\n \"supplier\": \"TECHDATA\"\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2023-09-29T17:12:48\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 0,\n \"id\": 16142,\n \"warehouseId\": 0,\n \"quantity\": 82,\n \"costPrice\": 400.95,\n \"productId\": 227237,\n \"supplier\": \"TECHDATA\"\n }\n ],\n \"supplierQuantity\": 246,\n \"localReservedQuantity\": 0,\n \"productId\": 227237,\n \"totalReservedQuantity\": 164\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 1\n}"}],"_postman_id":"e1765432-ebf7-4d54-9524-6e14d7577b4d"},{"name":"Get Product Inventory By Warehouse","id":"59b533c7-c0e2-4f77-b984-d0e6eb9288c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/warehouses/:warehouseId","description":"

This endpoint gives cumulative product inventory data by searching on a lookup key and warehouse id.

Expands cumulative inventory data with detailed records

\n","type":"text/plain"},"key":"expands","value":"inventoryBalance"}],"variable":[{"description":{"content":"

Available lookup keys: id, sourceId, sku, supplierCode

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupkey"},{"description":{"content":"

Lookup key value

\n","type":"text/plain"},"type":"any","value":"38952","key":"key"},{"description":{"content":"

Warehouse id

\n","type":"text/plain"},"type":"any","value":"4","key":"warehouseId"}]}},"response":[{"id":"5f8c3dff-794e-4eb4-88ff-9cdade58bb79","name":"Get Product Inventory By Warehouse - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/warehouses/:warehouseId","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","warehouses",":warehouseId"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records","disabled":true}],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"},{"key":"warehouseId","value":"4","description":"Warehouse id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"156"},{"key":"date","value":"Thu, 10 Mar 2022 16:48:09 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"5f5e44f4-b507-4b29-98a1-46758e32dc3f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"localQuantity\": 16,\n \"totalQuantity\": 19,\n \"supplierQuantity\": 3,\n \"localReservedQuantity\": 0,\n \"totalReservedQuantity\": 0,\n \"supplierReservedQuantity\": 0,\n \"productId\": 38952\n }\n ],\n \"messages\": [],\n \"total\": 1\n}"},{"id":"6c0b7000-f1b5-4c4c-9307-135be581357d","name":"Get Product Inventory By Warehouse - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/warehouses/:warehouseId","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","warehouses",":warehouseId"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records","disabled":true}],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"59328","description":"Lookup key value"},{"key":"warehouseId","value":"4","description":"Warehouse id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Thu, 10 Mar 2022 16:49:21 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"1e2c4820-7217-4d15-a8e2-37d5e57c604c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [59328] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"}],"_postman_id":"59b533c7-c0e2-4f77-b984-d0e6eb9288c1"},{"name":"Create Product Supplier Inventory","id":"d5dac706-b816-4afd-84ee-650060ea174c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000,\r\n \"supplier\": \"KERRIDGE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","description":"

This endpoint allows creating supplier inventory data for a product based on a lookup key.

Available fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	yes
supplier (string)	no Default value is product supplier
warehouseId (integer)	no Default value is 0
company (InventoryCompanyUsergroupResource)	no
usergroup (InventoryCompanyUsergroupResource)	no
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

On creating a record, inventory type supplier is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: supplier, supplierCode, warehouseId and location, error is thrown that duplicate record can't be created.

InventoryCompanyUsergroup Resource

A InventoryCompanyUsergroup resource is a JSON object used for identifying a company or usergroup when creating company/ usergroup specific stock record. It can be identified by either an id or source/ sourceId.

{\n    \"id\": 56987\n}\n\n

   \"sourceId\": \"1\",\n   \"source\": \"TECHDATA\",\n   \"language\": \"NL\"\n}\n\n

Available lookup keys: id, sourceId, sku, supplierCode

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupkey"},{"description":{"content":"

Lookup key value

\n","type":"text/plain"},"type":"any","value":"38952","key":"key"}]}},"response":[{"id":"87df0411-204f-48d4-a897-e4673a54fa79","name":"Create Product Supplier Inventory - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000,\r\n \"supplier\": \"KERRIDGE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"306"},{"key":"date","value":"Fri, 11 Mar 2022 11:06:39 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"62921947-254e-4c42-bd72-3e4183e4c9f3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2022-03-11T11:06:39\",\n \"notes\": \"\",\n \"location\": \"L5\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16195,\n \"warehouseId\": 4,\n \"quantity\": 16,\n \"costPrice\": 11.31,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n \n },\n \"messages\": [\n \"Inventory created\"\n ],\n \"total\": 1\n}"},{"id":"68b1454a-60a8-4a57-aecf-4f9ec83cfc01","name":"Create Product Supplier Inventory - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000,\r\n \"supplier\": \"KERRIDGE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"157"},{"key":"date","value":"Fri, 11 Mar 2022 11:06:16 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"727ad1af-8637-4512-8e7d-1be97c91017f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13004\",\n \"messages\": [\n \"Inventory already exists\"\n ],\n \"status\": 400,\n \"code\": 13004,\n \"type\": \"InventoryExists\"\n }\n}"},{"id":"a628bd25-0e32-42a6-82d8-7fa4cd4af3a2","name":"Create Product Supplier Inventory - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000,\r\n \"supplier\": \"KERRIDGE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"98952","description":"Lookup key value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Fri, 11 Mar 2022 11:07:00 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"b22dee12-41cb-411e-813b-56370e516d45"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [98952] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"},{"id":"c32f6be9-2f22-49c3-84a2-e0254ce38339","name":"Create Product Supplier Inventory for a usergroup - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000,\r\n \"supplier\": \"KERRIDGE\",\r\n \"usergroup\": {\r\n \"id\": 143\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"227235","description":"Lookup key value"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"332"},{"key":"Date","value":"Mon, 02 Oct 2023 15:03:49 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2023-10-02T15:03:49\",\n \"notes\": \"\",\n \"usergroupId\": 143,\n \"location\": \"L5\",\n \"sku\": \"9789006953374\",\n \"supplierCode\": \"\",\n \"companyId\": 0,\n \"id\": 16146,\n \"warehouseId\": 0,\n \"quantity\": 16,\n \"costPrice\": 11.31,\n \"productId\": 227235,\n \"supplier\": \"KERRIDGE\"\n },\n \"messages\": [\n \"Inventory created\"\n ],\n \"total\": 1\n}"}],"_postman_id":"d5dac706-b816-4afd-84ee-650060ea174c"},{"name":"Create Product Local Inventory","id":"03071a77-bc9d-4c5c-8fea-da4a389eac8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","description":"

This endpoint allows creating local inventory data for a product based on a lookup key.

Available fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	yes
warehouseId (integer)	no Default value is 0
company (InventoryCompanyUsergroupResource)	no
usergroup (InventoryCompanyUsergroupResource)	no
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

On creating a record, inventory type local is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: sku, warehouseId and location, error is thrown that duplicate record can't be created.

Available lookup keys: id, sourceId, sku, supplierCode

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupkey"},{"description":{"content":"

Lookup key value

\n","type":"text/plain"},"type":"any","value":"227235","key":"key"}]}},"response":[{"id":"febb5df2-9c6e-43ad-b084-649aba3d9cfe","name":"Create Product Local Inventory - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"304"},{"key":"date","value":"Fri, 11 Mar 2022 11:04:29 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"a3887357-85cc-475b-9d6c-c170c0449446"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2022-03-11T11:04:29\",\n \"notes\": \"\",\n \"location\": \"L5\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16194,\n \"warehouseId\": 4,\n \"quantity\": 16,\n \"costPrice\": 11.31,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n \"messages\": [\n \"Inventory created\"\n ],\n \"total\": 1\n}"},{"id":"136ea6a4-9e23-4c8b-9308-4e6c3a1be07a","name":"Create Product Local Inventory - 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"157"},{"key":"date","value":"Fri, 11 Mar 2022 11:04:07 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"6fa715b9-3713-4c89-bdf1-069517106c53"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13004\",\n \"messages\": [\n \"Inventory already exists\"\n ],\n \"status\": 400,\n \"code\": 13004,\n \"type\": \"InventoryExists\"\n }\n}"},{"id":"29ab2a55-7239-45bd-8f97-b017e4070e08","name":"Create Product Local Inventory - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"98952","description":"Lookup key value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Fri, 11 Mar 2022 11:05:01 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"298fde61-a7bd-4f67-a059-fae3ea541591"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [98952] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"},{"id":"b1a51075-03b8-4f89-b3a3-942681d287f0","name":"Create Product Local Inventory for a usergroup - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 16,\r\n \"location\": \"L5\",\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"costPrice\": 11.31000,\r\n \"usergroup\": {\r\n \"id\": 143\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"227235","description":"Lookup key value"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"330"},{"key":"Date","value":"Mon, 02 Oct 2023 15:08:39 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2023-10-02T15:08:39\",\n \"notes\": \"\",\n \"usergroupId\": 143,\n \"location\": \"L5\",\n \"sku\": \"9789006953374\",\n \"supplierCode\": \"\",\n \"companyId\": 0,\n \"id\": 16148,\n \"warehouseId\": 0,\n \"quantity\": 16,\n \"costPrice\": 11.31,\n \"productId\": 227235,\n \"supplier\": \"INTERN\"\n },\n \"messages\": [\n \"Inventory created\"\n ],\n \"total\": 1\n}"}],"_postman_id":"03071a77-bc9d-4c5c-8fea-da4a389eac8e"},{"name":"Update Product Supplier Inventory","id":"4b24c3cd-8c1e-4e2f-9f27-28dbe4863826","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"supplier\": \"KERRIDGE\",\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","description":"

This endpoint allows updating supplier inventory data for a product based on a lookup key.

Available fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	no
supplier (string)	no Default value is product supplier
warehouseId (integer)	no Default value is 0
company (InventoryCompanyUsergroupResource)	no
usergroup (InventoryCompanyUsergroupResource)	no
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

Inventory will be updated if record is found, matching on: product supplierCode, supplier, warehouseId and location. Error is thrown if record can't be found.

Fields supplier, warehouseId and location can't be updated, used only to find the correct inventory record.

Available lookup keys: id, sourceId, sku, supplierCode

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupkey"},{"description":{"content":"

Lookup key value

\n","type":"text/plain"},"type":"any","value":"38952","key":"key"}]}},"response":[{"id":"80f162ca-f8be-4dab-9263-ea36a511924a","name":"Update Product Supplier Inventory - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"supplier\": \"KERRIDGE\",\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"308"},{"key":"date","value":"Fri, 11 Mar 2022 10:49:08 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"dc5eb076-48b2-4236-a635-e840a3808511"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"dateModified\": \"2022-03-11T10:49:07\",\n \"notes\": \"\",\n \"location\": \"L5\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16152,\n \"warehouseId\": 4,\n \"quantity\": 3,\n \"costPrice\": 11.31,\n \"productId\": 38952,\n \"supplier\": \"KERRIDGE\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n \"messages\": [\n \"Inventory updated\"\n ],\n \"total\": 1\n}"},{"id":"11ad0355-945a-43a6-8b70-ed3eaacc31a2","name":"Update Product Supplier Inventory - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"supplier\": \"KERRIDGE\",\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"98952","description":"Lookup key value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Fri, 11 Mar 2022 10:49:39 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"86476432-c001-47ce-a91f-0e81432e4bda"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [98952] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"},{"id":"98102bae-d893-48ee-b728-12935347f4e6","name":"Update Product Supplier Inventory - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"supplier\": \"KERRIDGE\",\r\n \"location\": \"L5\",\r\n \"warehouseId\": 6,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"161"},{"key":"date","value":"Fri, 11 Mar 2022 10:50:02 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"36e60fe2-7c1e-45d0-afce-7cd9cb774de3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13006\",\n \"messages\": [\n \"Inventory record not found\"\n ],\n \"status\": 404,\n \"code\": 13006,\n \"type\": \"InventoryNotFound\"\n }\n}"},{"id":"3a77cab5-255e-4de1-82e0-8f4d89403cb2","name":"Update Product Supplier Inventory for a usergroup - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"supplier\": \"KERRIDGE\",\r\n \"location\": \"L5\",\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31,\r\n \"usergroup\": {\r\n \"id\": 143\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/supplier","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","supplier"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"227235","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"334"},{"key":"Date","value":"Mon, 02 Oct 2023 16:07:01 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"dateModified\": \"2023-10-02T16:07:01\",\n \"notes\": \"\",\n \"usergroupId\": 143,\n \"location\": \"L5\",\n \"sku\": \"9789006953374\",\n \"supplierCode\": \"\",\n \"companyId\": 0,\n \"id\": 16146,\n \"warehouseId\": 0,\n \"quantity\": 3,\n \"costPrice\": 11.31,\n \"productId\": 227235,\n \"supplier\": \"KERRIDGE\"\n },\n \"messages\": [\n \"Inventory updated\"\n ],\n \"total\": 1\n}"}],"_postman_id":"4b24c3cd-8c1e-4e2f-9f27-28dbe4863826"},{"name":"Update Product Local Inventory","id":"f87602a9-e2db-4a1f-b61d-1ff45a8ed3a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","description":"

This endpoint allows updating local inventory data for a product based on a lookup key.

Available fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	no
warehouseId (integer)	no Default value is 0
company (InventoryCompanyUsergroupResource)	no
usergroup (InventoryCompanyUsergroupResource)	no
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

Inventory will be updated if record is found, matching on: product sku, warehouseId and location. Error is thrown if record can't be found.

Fields warehouseId and location can't be updated, used only to find the correct inventory record.

Available lookup keys: id, sourceId, sku, supplierCode

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupkey"},{"description":{"content":"

Lookup key value

\n","type":"text/plain"},"type":"any","value":"38952","key":"key"}]}},"response":[{"id":"5c04a9bd-1d5a-46fb-9409-50dbe0a01e38","name":"Update Product Local Inventory - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"306"},{"key":"date","value":"Fri, 11 Mar 2022 10:46:50 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c53d54b7-5fc4-4dca-9444-8e6e60d5da38"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"dateModified\": \"2022-03-11T10:46:50\",\n \"notes\": \"\",\n \"location\": \"L5\",\n \"sku\": \"AA 0635613\",\n \"supplierCode\": \"AA 0635613\",\n \"id\": 16162,\n \"warehouseId\": 4,\n \"quantity\": 3,\n \"costPrice\": 11.31,\n \"productId\": 38952,\n \"supplier\": \"INTERN\",\n \"usergroupId\": 0,\n \"companyId\": 0\n },\n \"messages\": [\n \"Inventory updated\"\n ],\n \"total\": 1\n}"},{"id":"c92c334b-27fb-478b-985a-1fe4688c3dac","name":"Update Product Local Inventory - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"98952","description":"Lookup key value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"166"},{"key":"date","value":"Fri, 11 Mar 2022 10:47:19 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"60f65605-4c0d-4cf6-86f5-08d7df6a3074"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/80006\",\n \"messages\": [\n \"Product with id [98952] not found\"\n ],\n \"status\": 404,\n \"code\": 80006,\n \"type\": \"ProductNotFound\"\n }\n}"},{"id":"ed8be9c3-f51a-4c1f-b2a3-8f645631f35b","name":"Update Product Local Inventory - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"location\": \"L5\",\r\n \"warehouseId\": 6,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"38952","description":"Lookup key value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"161"},{"key":"date","value":"Fri, 11 Mar 2022 10:48:08 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"0d50b38a-3911-4141-8ecc-06cabbdb216f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13006\",\n \"messages\": [\n \"Inventory record not found\"\n ],\n \"status\": 404,\n \"code\": 13006,\n \"type\": \"InventoryNotFound\"\n }\n}"},{"id":"0557460f-80ca-43f4-a875-4dbf0fb8c2f3","name":"Update Product Local Inventory for a usergroup - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 3,\r\n \"location\": \"L5\",\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\r\n \"costPrice\": 11.31,\r\n \"usergroup\": {\r\n \"id\": 143\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local","host":["https://api.helice.cloud/api/g/v1"],"path":["products",":lookupkey",":key","inventory","local"],"variable":[{"key":"lookupkey","value":"id","description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"key":"key","value":"227235","description":"Lookup key value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"332"},{"key":"Date","value":"Mon, 02 Oct 2023 16:05:26 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-15T00:00:00\",\n \"dateModified\": \"2023-10-02T16:05:26\",\n \"notes\": \"\",\n \"usergroupId\": 143,\n \"location\": \"L5\",\n \"sku\": \"9789006953374\",\n \"supplierCode\": \"\",\n \"companyId\": 0,\n \"id\": 16148,\n \"warehouseId\": 0,\n \"quantity\": 3,\n \"costPrice\": 11.31,\n \"productId\": 227235,\n \"supplier\": \"INTERN\"\n },\n \"messages\": [\n \"Inventory updated\"\n ],\n \"total\": 1\n}"}],"_postman_id":"f87602a9-e2db-4a1f-b61d-1ff45a8ed3a4"},{"name":"Search Inventory","id":"b3940472-6ec3-4a1a-815c-ee2b417c6bf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"productIds\": [37232,38952,38953,77157,77158,227237],\r\n \"location\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/inventory/search?expands=inventoryBalance","description":"

This endpoint allows searching for product inventory cumulative quantities, separated by inventory type.

Available search fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Required
productIds (array [integer])	Array of product ids.	yes
warehouseId (integer)	Warehouse id.	no
location (string)	Location.	no

Mandatory field in search payload is productIds array. If warehouseId or location are not sent in the payload, inventories will not be filtered by warehouse and/or location.

Expands cumulative inventory data with detailed records

\n","type":"text/plain"},"key":"expands","value":"inventoryBalance"},{"disabled":true,"description":{"content":"

Number of records per page. Default value is 12

\n","type":"text/plain"},"key":"offset","value":"15"},{"disabled":true,"description":{"content":"

Page number. Default value is 1

\n","type":"text/plain"},"key":"page","value":"8"}],"variable":[]}},"response":[{"id":"97b3a7c4-c31a-45c0-9ed7-389da4c2ae65","name":"Search Inventory - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"productIds\": [37232,38952,38953,227197],\r\n \"location\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/search","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","search"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records","disabled":true},{"key":"offset","value":"15","description":"Number of records per page. Default value is 12","disabled":true},{"key":"page","value":"8","description":"Page number. Default value is 1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"331"},{"key":"Date","value":"Wed, 22 Jun 2022 07:24:56 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"localQuantity\": 20,\n \"totalQuantity\": 20,\n \"supplierQuantity\": 0,\n \"productId\": 37232\n },\n {\n \"nextDeliveryDate\": \"\",\n \"localQuantity\": 0,\n \"totalQuantity\": 0,\n \"supplierQuantity\": 0,\n \"productId\": 227197\n },\n {\n \"supplierReservedQuantity\": 164,\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"localQuantity\": 0,\n \"totalQuantity\": 262,\n \"supplierQuantity\": 246,\n \"localReservedQuantity\": 0,\n \"productId\": 227237,\n \"totalReservedQuantity\": 164\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 1,\n \"total\": 3,\n \"offset\": 12,\n \"itemsFound\": 3,\n \"end\": 3,\n \"page\": 1\n}"},{"id":"04a7de90-0693-4f9d-bdae-093c681d94da","name":"Search Inventory - 200 (expands inventoryBalance)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"productIds\": [37232,38952,38953,227197],\r\n \"location\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/search?expands=inventoryBalance","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","search"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records"},{"key":"offset","value":"15","description":"Number of records per page. Default value is 12","disabled":true},{"key":"page","value":"8","description":"Page number. Default value is 1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"585"},{"key":"Date","value":"Wed, 22 Jun 2022 07:25:25 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"supplierReservedQuantity\": 0,\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"localQuantity\": 26,\n \"totalQuantity\": 26,\n \"balance\": [\n {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2022-06-20T13:40:00\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"\",\n \"sku\": \"\",\n \"supplierCode\": \"757540\",\n \"companyId\": 0,\n \"id\": 1,\n \"warehouseId\": \"\",\n \"quantity\": 20,\n \"costPrice\": 25.50000,\n \"productId\": 37232,\n \"supplier\": \"\"\n },\n {\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"dateModified\": \"2022-08-29T21:27:39\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"B45\",\n \"sku\": \"757540\",\n \"supplierCode\": \"757540\",\n \"companyId\": 0,\n \"id\": 16132,\n \"warehouseId\": 2,\n \"quantity\": 3,\n \"costPrice\": 0,\n \"productId\": 37232,\n \"supplier\": \"INTERN\"\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2022-08-29T21:29:17\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"\",\n \"sku\": \"757540\",\n \"supplierCode\": \"757540\",\n \"companyId\": 0,\n \"id\": 16138,\n \"warehouseId\": 0,\n \"quantity\": 3,\n \"costPrice\": 0,\n \"productId\": 37232,\n \"supplier\": \"INTERN\"\n }\n ],\n \"supplierQuantity\": 0,\n \"localReservedQuantity\": 0,\n \"productId\": 37232,\n \"totalReservedQuantity\": 0\n },\n {\n \"supplierReservedQuantity\": 164,\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"localQuantity\": 0,\n \"totalQuantity\": 262,\n \"balance\": [\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2023-09-29T17:54:11\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 227583,\n \"id\": 16139,\n \"warehouseId\": 0,\n \"quantity\": 87,\n \"costPrice\": 400.95000,\n \"productId\": 227237,\n \"supplier\": \"TECHDATA\"\n },\n {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2023-09-28T19:56:35\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"L5\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 0,\n \"id\": 16140,\n \"warehouseId\": 0,\n \"quantity\": 16,\n \"costPrice\": 11.31000,\n \"productId\": 227237,\n \"supplier\": \"KERRIDGE\"\n },\n {\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\",\n \"dateModified\": \"2023-09-29T17:54:11\",\n \"notes\": \"\",\n \"usergroupId\": 143,\n \"location\": \"B45\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 0,\n \"id\": 16141,\n \"warehouseId\": 0,\n \"quantity\": 77,\n \"costPrice\": 400.95000,\n \"productId\": 227237,\n \"supplier\": \"TECHDATA\"\n },\n {\n \"nextDeliveryDate\": \"\",\n \"dateModified\": \"2023-09-29T17:12:48\",\n \"notes\": \"\",\n \"usergroupId\": 0,\n \"location\": \"\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 0,\n \"id\": 16142,\n \"warehouseId\": 0,\n \"quantity\": 82,\n \"costPrice\": 400.95000,\n \"productId\": 227237,\n \"supplier\": \"TECHDATA\"\n }\n ],\n \"supplierQuantity\": 246,\n \"localReservedQuantity\": 0,\n \"productId\": 227237,\n \"totalReservedQuantity\": 164\n },\n {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"localQuantity\": 20,\n \"totalQuantity\": 20,\n \"balance\": [\n {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2022-06-20T13:40:00\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"\",\n \"supplierCode\": \"757540\",\n \"id\": 1,\n \"warehouseId\": \"\",\n \"quantity\": 20,\n \"costPrice\": 25.5,\n \"productId\": 37232,\n \"supplier\": \"\"\n }\n ],\n \"supplierQuantity\": 0,\n \"productId\": 37232\n },\n {\n \"nextDeliveryDate\": \"\",\n \"localQuantity\": 0,\n \"totalQuantity\": 0,\n \"balance\": [],\n \"supplierQuantity\": 0,\n \"productId\": 227197\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 1,\n \"total\": 3,\n \"offset\": 12,\n \"itemsFound\": 3,\n \"end\": 3,\n \"page\": 1\n}"},{"id":"aa5b1801-0145-4c29-8f6e-bfc8f0f5932a","name":"Search Inventory - 400 (empty productIds array)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"productIds\": [],\r\n \"location\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/search?expands=inventoryBalance","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","search"],"query":[{"key":"expands","value":"inventoryBalance","description":"Expands cumulative inventory data with detailed records"},{"key":"offset","value":"15","description":"Number of records per page. Default value is 12","type":"text","disabled":true},{"key":"page","value":"8","description":"Page number. Default value is 1","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"197"},{"key":"Date","value":"Wed, 22 Jun 2022 07:26:31 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/productIds: expected minimum item count: 1, found: 0\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"b3940472-6ec3-4a1a-815c-ee2b417c6bf9"}],"id":"7e22d4a3-c1f7-473a-a62d-55c1dcbc84c8","description":"

Product Inventory API gives you access to products inventory data. Product inventory item gives sumarized inventory data for the product, giving you primary supplier, local and total stock quantities. These quantities will potentially include customer specific i.e. reserved stock quantities. For that reason, the product inventory data also includes summarized reserved quantities.

You can create or update inventory quantities for the product by finding it with one of the lookup keys.

Product inventory item fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
productId (integer)	Product unique id.
localQuantity (integer)	Available local stock quantity.
supplierQuantity (integer)	Available primary supplier stock quantity.
totalQuantity (string)	Available total stock quantity (all suppliers and local inventory).
localReservedQuantity (integer)	Available reserved local stock quantity.
supplierlReservedQuantity (integer)	Available reserved primary supplier stock quantity.
totallReservedQuantity (string)	Available reserved total stock quantity (all suppliers and local inventory).
nextDeliveryDate (string)	Earliest expected date to receive new product stock.

Available lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
id (integer)	Product id
sourceId (integer)	Product source id. With source id lookup key, source is required
sku (string)	Product sku
supplierCode (string)	Product supplier code

","_postman_id":"7e22d4a3-c1f7-473a-a62d-55c1dcbc84c8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Get Inventory By ID","id":"f2ca2613-3fef-4c98-9e8d-3d45644c1365","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/inventory/id/:id","description":"

This endpoint is used to get an inventory data via it's unique inventory record ID.

Inventory ID

\n","type":"text/plain"},"type":"any","value":"16141","key":"id"}]}},"response":[{"id":"86cac202-b3ae-4445-92a0-3dff00e9284c","name":"Get Inventory By ID - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/id/:id","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","id",":id"],"variable":[{"key":"id","value":"16141","description":"Inventory ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"273"},{"key":"date","value":"Wed, 09 Mar 2022 09:29:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e6c6fd2d-baeb-4cf1-ae6e-cefe5b825513"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2021-02-25T00:00:00\",\n \"dateModified\": \"2022-02-21T12:52:38\",\n \"notes\": \"\",\n \"location\": \"\",\n \"sku\": \"757540\",\n \"supplierCode\": \"757540\",\n \"id\": 16141,\n \"warehouseId\": 4,\n \"quantity\": 15,\n \"costPrice\": 0,\n \"productId\": 37232,\n \"supplier\": \"QUANTORE\",\n \"companyId\": 0,\n \"usergroupId\": 143\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"6a354c66-16cc-4da9-aa70-6329e082d237","name":"Get Inventory By ID - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/id/:id","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","id",":id"],"variable":[{"key":"id","value":"58991","description":"Inventory ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"170"},{"key":"date","value":"Wed, 09 Mar 2022 09:31:37 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"07314bc9-feee-4d00-98e6-5833bc3808e9"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13006\",\n \"messages\": [\n \"Inventory with id [58991] not found\"\n ],\n \"status\": 404,\n \"code\": 13006,\n \"type\": \"InventoryNotFound\"\n }\n}"}],"_postman_id":"f2ca2613-3fef-4c98-9e8d-3d45644c1365"},{"name":"Update Inventory By ID","id":"e5dc29cc-1ea7-4432-8dba-3e75fe1d4176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 20,\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"notes\": \"\",\r\n \"costPrice\": 25.50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/inventory/id/:id","description":"

This endpoint enables updating inventory record by it's unique id.

Available update fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	no
costPrice (integer)	no
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

warehouseId and location can't be updated.

If product stock is moved to a different warehouse or location, old inventory record should be updated with 0 quantity, then create a new record with the new warehouseId and/or location

Inventory record ID

\n","type":"text/plain"},"type":"any","value":"16141","key":"id"}]}},"response":[{"id":"4ec02785-75d4-4968-a9c8-c22b3c7856fe","name":"Update Inventory By ID - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 20,\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"notes\": \"\",\r\n \"costPrice\": 25.50\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/id/:id","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","id",":id"],"variable":[{"key":"id","value":"16141","description":"Inventory record ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"339"},{"key":"Date","value":"Mon, 02 Oct 2023 19:33:14 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\n \"dateModified\": \"2023-10-02T19:33:14\",\n \"notes\": \"\",\n \"usergroupId\": 143,\n \"location\": \"B45\",\n \"sku\": \"NCABD70004\",\n \"supplierCode\": \"NCABD70004\",\n \"companyId\": 0,\n \"id\": 16141,\n \"warehouseId\": 0,\n \"quantity\": 20,\n \"costPrice\": 25.5,\n \"productId\": 227237,\n \"supplier\": \"TECHDATA\"\n },\n \"messages\": [\n \"Inventory updated\"\n ],\n \"total\": 1\n}"},{"id":"1cf11410-cd1e-4ac7-84ef-ed8f9e8743a2","name":"Update Inventory By ID - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"quantity\": 20,\r\n \"nextDeliveryDate\": \"2022-02-20T00:00:00\",\r\n \"notes\": \"\",\r\n \"costPrice\": 25.50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/inventory/id/58991"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"378"},{"key":"date","value":"Thu, 10 Mar 2022 15:31:35 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e0322069-5ccc-4942-94a3-51f1477fa9c4"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13006\",\n \"messages\": [\n \"Inventory with id [58991] not found\"\n ],\n \"status\": 404,\n \"code\": 13006,\n \"type\": \"InventoryNotFound\"\n }\n}"}],"_postman_id":"e5dc29cc-1ea7-4432-8dba-3e75fe1d4176"},{"name":"Delete Inventory By ID","id":"a081fd8e-6c12-4725-b4f6-36f20617c020","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/inventory/id/:id","description":"

This endpoint allows deleting inventory record by it's Propeller inventory id.

Inventory record ID

\n","type":"text/plain"},"type":"any","value":"16142","key":"id"}]}},"response":[{"id":"2378260d-73ed-4985-917e-36373b2408cf","name":"Delete Inventory By ID - 200","originalRequest":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/inventory/id/16142"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"46"},{"key":"date","value":"Wed, 09 Mar 2022 10:04:17 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"5ac2d4fc-9402-40fa-96cd-5593689b756a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Inventory deleted\"\n ]\n}"},{"id":"a45a3a47-97b4-4ba2-b22f-a21188faf788","name":"Delete Inventory By ID - 404","originalRequest":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/inventory/id/58991"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"170"},{"key":"date","value":"Wed, 09 Mar 2022 10:04:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"6404936a-7275-4eaf-8b60-f12e3846d4b2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13006\",\n \"messages\": [\n \"Inventory with id [58991] not found\"\n ],\n \"status\": 404,\n \"code\": 13006,\n \"type\": \"InventoryNotFound\"\n }\n}"}],"_postman_id":"a081fd8e-6c12-4725-b4f6-36f20617c020"},{"name":"Bulk Supplier Inventory (deprecated)","id":"6a8a11c0-5dc5-4c1b-bd03-876049d22cc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 15,\r\n \"supplier\": \"QUANTORE\",\r\n \"supplierCode\": \"757540\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-02-25T00:00:00\"\r\n },\r\n {\r\n \"quantity\": 3,\r\n \"supplier\": \"QUANTORE\",\r\n \"supplierCode\": \"851071\",\r\n \"location\": \"B45\",\r\n \"warehouseId\": 2,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\"\r\n },\r\n {\r\n \"quantity\": 5,\r\n \"supplier\": \"KERRIDGE\",\r\n \"supplierCode\": \"AA 0635613\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/inventory/bulk/supplier","description":"

The bulk supplier inventory endpoint is used to create or update inventory records.

This endpoint is deprecated in favor of Bulk Inventory by lookup key / inventory type where you can use the same payload, but you need to set the lookup key param to supplierCode and the inventory type param to supplier.

On creating a record, inventory type supplier is matching the product on two fields: supplier and supplierCode. If the product is found, inventory record will be created.

For updating a record, matching fields are: supplier, supplierCode, warehouseId and location. Record is updated only when inventory record with all four matching fields is found, otherwise new record is created.

Available fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	yes
supplier (string)	yes
supplierCode (string)	yes
warehouseId (integer)	no Default value is 0
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

The bulk local inventory endpoint is used to create or update inventory records.

This endpoint is deprecated in favor of Bulk Inventory by lookup key / inventory type where you can use the same payload, but you need to set the lookup key param to sku and the inventory type param to local.

On creating a record, inventory type local is matching the product on the field sku. If the product is found, inventory record will be created.

For updating a record, matching fields are: sku, warehouseId and location. Record is updated only when inventory record with all three matching fields is found, otherwise new record is created.

Available fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	yes
sku (string)	yes
warehouseId (integer)	no Default value is 0
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

The bulk inventory endpoint is used to create or update inventory records. The products can be identified based on one of their lookup keys. The inventory record type can be either local or supplier.

When looking up an inventory record, the matching fields are: lookupKey, warehouseId and location. If a record already exists it will be updated, otherwise a new record is created.

Available fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
quantity (integer)	yes
sku (string)	only when lookup key is `sku`
supplierCode (string)	only when lookup key is `supplierCode`
supplier (string)	only when lookup key is `supplierCode`
id (integer)	only when lookup key is `id`
sourceId (string)	only when lookup key is `sourceId`
source (string)	only when lookup key is `sourceId`
language (string)	only when lookup key is `sourceId`
warehouseId (integer)	no Default value is 0
company (InventoryCompanyUsergroupResource)	no
usergroup (InventoryCompanyUsergroupResource)	no
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

Lookup key. Read more about product lookup keys

\n","type":"text/plain"},"type":"any","value":"sourceId","key":"lookupKey"},{"description":{"content":"

Inventory type. local or supplier

\n","type":"text/plain"},"type":"any","value":"supplier","key":"inventoryType"}]}},"response":[{"id":"fede3602-49e1-40e9-8dfc-661956845ea1","name":"Bulk supplier inventory by source id - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 77,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70005\",\r\n \"language\": \"NL\",\r\n \"location\": \"B45\",\r\n \"warehouseId\": 2,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\"\r\n },\r\n {\r\n \"quantity\": 87,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"supplier","description":"Inventory type. `local` or `supplier`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"139"},{"key":"Date","value":"Mon, 29 Aug 2022 21:01:29 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"id\": 16134,\n \"action\": \"update\"\n },\n {\n \"success\": true,\n \"id\": 16135,\n \"action\": \"update\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"6278d42c-2202-495a-a921-971e8203d0e6","name":"Bulk supplier inventory by source id - 400 (invalid inventory type)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 77,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70005\",\r\n \"language\": \"NL\",\r\n \"location\": \"B45\",\r\n \"warehouseId\": 2,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\"\r\n },\r\n {\r\n \"quantity\": 87,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"suppliers","description":"Inventory type. `local` or `supplier`"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"237"},{"key":"Date","value":"Mon, 29 Aug 2022 21:23:13 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/13007\",\n \"messages\": [\n \"Invalid inventory type [suppliers], type must contain one of the following values: [local,supplier]\"\n ],\n \"status\": 400,\n \"code\": 13007,\n \"type\": \"InvalidInventoryType\"\n }\n}"},{"id":"872fe53b-280d-439e-9ada-e0497c2216f6","name":"Bulk supplier inventory by sourceId - 400 (invalid lookup key)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 77,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70005\",\r\n \"language\": \"NL\",\r\n \"location\": \"B45\",\r\n \"warehouseId\": 2,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\"\r\n },\r\n {\r\n \"quantity\": 87,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"sourceIds","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"supplier","description":"Inventory type. `local` or `supplier`"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"242"},{"key":"Date","value":"Mon, 29 Aug 2022 21:24:02 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [sourceIds], key must contain one of the following values: [id,sourceId,sku,suppliercode]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"},{"id":"d854ac98-ab3c-4488-ab12-f01e013176ba","name":"Bulk local inventory by sourceId - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 77,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70005\",\r\n \"language\": \"NL\",\r\n \"location\": \"B45\",\r\n \"warehouseId\": 2,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\"\r\n },\r\n {\r\n \"quantity\": 87,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"local","description":"Inventory type. `local` or `supplier`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"139"},{"key":"Date","value":"Mon, 29 Aug 2022 21:25:13 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"id\": 16136,\n \"action\": \"create\"\n },\n {\n \"success\": true,\n \"id\": 16137,\n \"action\": \"create\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"f11a29a8-36bf-4498-8294-da027ae64944","name":"Bulk supplier inventory by supplier code - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 15,\r\n \"supplier\": \"QUANTORE\",\r\n \"supplierCode\": \"757540\",\r\n \"warehouseId\": 4,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-02-25T00:00:00\"\r\n },\r\n {\r\n \"quantity\": 3,\r\n \"supplier\": \"QUANTORE\",\r\n \"supplierCode\": \"851071\",\r\n \"location\": \"B45\",\r\n \"warehouseId\": 2,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\"\r\n },\r\n {\r\n \"quantity\": 5,\r\n \"supplier\": \"KERRIDGE\",\r\n \"supplierCode\": \"AA 0635613\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"supplierCode","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"supplier","description":"Inventory type. `local` or `supplier`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"232"},{"key":"Date","value":"Mon, 29 Aug 2022 21:26:27 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"message\": \"Product with supplierCode [757540] not found\",\n \"success\": false,\n \"action\": \"create\"\n },\n {\n \"success\": true,\n \"id\": 16125,\n \"action\": \"update\"\n },\n {\n \"success\": true,\n \"id\": 16126,\n \"action\": \"update\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 3\n}"},{"id":"34e9421a-5c61-45a4-9d97-41dbda5aeeb7","name":"Bulk local inventory by sku - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"sku\": \"AA 0635613\",\r\n \"quantity\": 13\r\n },\r\n {\r\n \"quantity\": 3,\r\n \"sku\": \"757540\",\r\n \"location\": \"B45\",\r\n \"warehouseId\": 2,\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01T00:00:00\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"sku","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"local","description":"Inventory type. `local` or `supplier`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"139"},{"key":"Date","value":"Mon, 29 Aug 2022 21:27:40 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"id\": 16131,\n \"action\": \"update\"\n },\n {\n \"success\": true,\n \"id\": 16132,\n \"action\": \"update\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"57339072-fdd2-4401-b17b-b7eb7a26fc6a","name":"Bulk local inventory by id - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"id\": 38848,\r\n \"quantity\": 13\r\n },\r\n {\r\n \"id\": 37232,\r\n \"quantity\": 3\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"local","description":"Inventory type. `local` or `supplier`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"139"},{"key":"Date","value":"Mon, 29 Aug 2022 21:29:18 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"id\": 16131,\n \"action\": \"update\"\n },\n {\n \"success\": true,\n \"id\": 16138,\n \"action\": \"create\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"b9547976-a4b5-411c-ae4b-132b5208e029","name":"Bulk supplier inventory by source id for company and usergroup - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 77,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\",\r\n \"location\": \"B45\",\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\",\r\n \"usergroup\": {\r\n \"id\": 143\r\n }\r\n },\r\n {\r\n \"quantity\": 87,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\",\r\n \"company\": {\r\n \"source\": \"TESTSOURCE\",\r\n \"sourceId\": 1,\r\n \"language\": \"NL\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"supplier","description":"Inventory type. `local` or `supplier`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"139"},{"key":"Date","value":"Mon, 02 Oct 2023 19:34:34 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"id\": 16141,\n \"action\": \"update\"\n },\n {\n \"success\": true,\n \"id\": 16139,\n \"action\": \"update\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"c8512cc2-7c24-42ca-8011-2399db22fa7b","name":"Bulk supplier inventory by source id for company and non existing usergroup - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"inventory\": [\r\n {\r\n \"quantity\": 77,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\",\r\n \"location\": \"B45\",\r\n \"notes\": \"\",\r\n \"nextDeliveryDate\": \"2021-03-01 00:00:00\",\r\n \"usergroup\": {\r\n \"id\": 143111\r\n }\r\n },\r\n {\r\n \"quantity\": 87,\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\",\r\n \"company\": {\r\n \"source\": \"TESTSOURCE\",\r\n \"sourceId\": 1,\r\n \"language\": \"NL\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/inventory/bulk/:lookupKey/:inventoryType","host":["https://api.helice.cloud/api/g/v1"],"path":["inventory","bulk",":lookupKey",":inventoryType"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"key":"inventoryType","value":"supplier","description":"Inventory type. `local` or `supplier`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"178"},{"key":"Date","value":"Mon, 02 Oct 2023 19:36:04 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"message\": \"Usergroup with id [143111] not found\",\n \"success\": false,\n \"action\": \"create\"\n },\n {\n \"success\": true,\n \"id\": 16139,\n \"action\": \"update\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"}],"_postman_id":"5157c0a2-204b-48fb-94b7-850ffd90f98a"}],"id":"b5922e4f-cfb7-41c3-8974-2e50e2eb6fb3","description":"

Inventory API gives you access to your warehouses and warehouse locations, so you can adjust inventory quantities and review inventory changes for products in your catalog. Inventory API allows you to update the local and supplier inventory of each product.

Can work with multiple warehouses, but also organize your warehouse and divide it to as many locations as you want to easily find the products.

Inventory allows you to track stock quantities per SKU and optionally per supplier and supplier product code. That's why there are two types of inventory: local and supplier.

Inventory can also be customer specific, i.e. reserved for a given company and/ or usergroup.

Inventory item fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Required
id (integer)	Propeller inventory record unique id.	yes
productId (integer)	Propeller product unique id.	yes
quantity (integer)	Available stock quantity.	yes
costPrice (integer)	Product cost price.	no Default value is 0.00
supplier (string)	Supplier name. For local stock this value is always INTERN and for supplier stock by default this is the product supplier value, but also can create stock for a different suppliers	yes
supplierCode (string)	Suppliers' unique identifier for the product	yes
sku (string)	Product unique code	yes
dateModified (date)	Date and time when the stock record is modified.	yes
warehouseId (integer)	Warehouse unique id. If warehouseId is not specified, it's set to 0 by default.	yes
companyId (integer)	Company specific (reserved) inventory. Quantity reserved for a given company	no Defaults to `0`
usergroupId (integer)	Usergroup specific (reserved) inventory. Quantity reserved for a given usergroup. Will be deprecated in cloud	no Defaults to `0`
location (string)	Racks and shelves in the warehouse can be named and keep track of product stock location name.	no
nextDeliveryDate (date)	Expected date to receive new product stock	no
notes (string)	Inventory record notes.	no

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Required
id (integer)	Propeller inventory record unique id.	yes

Expands

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Required
inventoryBalance	With inventoryBalance expanded, detailed view of all inventory records is returned for every product.	no

Inventory Errors

This section describes error codes specific for the Inventory resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
13004	InventoryExists	400	Inventory already exists	Inventory already exists
13005	InventoryMultipleFound	400	Multiple inventories found. Please provide additional filters	Multiple inventory records with such search criteria exist
13006	InventoryNotFound	404	Inventory does not exist	Inventory with such lookup key not found
13007	InvalidInventoryType	400	Invalid inventory type	Not a valid inventory type

","_postman_id":"b5922e4f-cfb7-41c3-8974-2e50e2eb6fb3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Pricesheets","item":[{"name":"Get Pricesheets","id":"12a0820a-9c60-4eae-849d-bde15499ed09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/pricesheets","description":"

Use this endpoint to retrieve a list of all price sheets.

Use this endpoint to create a price sheet. If a price sheet is successfully created, the response will include the price sheet id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
code	yes
shopId	no Defaults to first shop found
name	no
description	no

Use this endpoint to define pricing for an existing price sheet. The price sheet can be identified by it's lookup key. It is required to provide either categories or products or both.

Use cases

A common use case for this endpoint is when you want to give discounts on all products in a certain category or set a specific price from your ERP system for a product. You can decide to assign a price sheet to only one or multiple users. You can also create a price sheet in advance, create the pricing and have it be ready to assign to a user or usergroup at any given moment i.e. when a sales team decides to.

If you want to give a discount of 20% of sales price on all products in a given category you can use the SP type pricing for a category. The discount will apply on all products that belong in that category.

Another common use case is to set a specific price for a product. This is usually used when your ERP system is responsible for the complex price calculations or simply your sales team agreed on a specific price for a product.

Lookup key. Read more about price sheet lookup keys

\n","type":"text/plain"},"type":"any","value":"code","key":"lookupKey"},{"description":{"content":"

The value of the key (id or code)

\n","type":"text/plain"},"type":"any","value":"3A21","key":"lookupValue"}]}},"response":[{"id":"fcaed895-0aa2-47a2-9459-69115a0a9ede","name":"Create Pricesheet Pricing","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"categories\":[\r\n {\r\n \"id\": 1779,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n } \r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 40364,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n },\r\n {\r\n \"id\": 40362,\r\n \"pricing\": {\r\n \"price\": 4,\r\n \"quantity\": 2,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n }\r\n ]\r\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A21","description":"The value of the key (id or code)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"238"},{"key":"date","value":"Thu, 31 Mar 2022 17:19:11 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"c366ac98-e2f7-4457-8c4f-c65cc0916cff"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": 1779,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 40364,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 40362,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"completed\"\n ],\n \"total\": 3\n}"},{"id":"8d69ff84-cc74-4595-9979-efcaa44d9c8a","name":"Create Pricesheet Pricing - 400 (invalid schema)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"categories\":[\r\n {\r\n \"id\": 17795,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n } \r\n }\r\n ],\r\n \"product\": [\r\n {\r\n \"id\": 40364,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n },\r\n {\r\n \"id\": 40362,\r\n \"pricing\": {\r\n \"price\": 4,\r\n \"quantity\": 2,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n }\r\n ]\r\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A21","description":"The value of the key (id or code)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"187"},{"key":"date","value":"Thu, 31 Mar 2022 17:19:46 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e580c6c8-feda-473b-9efd-d40d1454c708"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#: extraneous key [product] is not permitted\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"f3ef3dd2-de35-481d-b54d-80193739f917","name":"Create Pricesheet Pricing - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"categories\":[\r\n {\r\n \"id\": 17795,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n } \r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 40364,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n },\r\n {\r\n \"id\": 40362,\r\n \"pricing\": {\r\n \"price\": 4,\r\n \"quantity\": 2,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n }\r\n ]\r\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A212","description":"The value of the key (id or code)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"200"},{"key":"date","value":"Thu, 31 Mar 2022 17:33:06 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"00967621-4860-45b6-8e44-1eb6d4fffc09"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/12005\",\n \"messages\": [\n \"Parent resource [Pricesheets] with code [3A212] not found\"\n ],\n \"status\": 404,\n \"code\": 12005,\n \"type\": \"ParentPricesheetsNotFound\"\n }\n}"},{"id":"13c01ef8-c397-41db-9b2c-53276e0bcabc","name":"Create Pricesheet Pricing - 200 (invalid category)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"categories\":[\r\n {\r\n \"id\": 17795,\r\n \"pricing\": {\r\n \"amount\": 10,\r\n \"type\": \"CP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n } \r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"id\": 40364,\r\n \"pricing\": {\r\n \"amount\": 20,\r\n \"type\": \"SP\",\r\n \"quantity\": 1,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n },\r\n {\r\n \"id\": 40362,\r\n \"pricing\": {\r\n \"price\": 4,\r\n \"quantity\": 2,\r\n \"validFrom\": \"2022-05-01\",\r\n \"validTo\": \"2022-12-31\"\r\n }\r\n }\r\n ]\r\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A21","description":"The value of the key (id or code)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"285"},{"key":"date","value":"Fri, 01 Apr 2022 07:52:25 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"fe6530f0-afa0-4a82-bcd4-7d797245d595"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"error\": \"category with id [17795] not found\",\n \"success\": false,\n \"key\": 17795,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 40364,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n },\n {\n \"success\": true,\n \"key\": 40362,\n \"action\": \"create\",\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"completed\"\n ],\n \"total\": 3\n}"}],"_postman_id":"08f19022-aa1b-48a4-9cd8-767a754f1a19"},{"name":"Get Pricesheet by lookup key","id":"2a3d7a96-f6bd-4787-b91c-223ea71533fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue?expands=products,categories","description":"

Use this endpoint to retrieve price sheet details by lookup key. The expands parameter can be used to retrieve the pricing for the price sheet.

Optional. Use products and/ or categories to retrieve the pricing defined on product/ category level. By default, no pricing will be retrieved.

What is resource expanding?

\n","type":"text/plain"},"key":"expands","value":"products,categories"}],"variable":[{"description":{"content":"

Lookup key. Read more about price sheet lookup keys

\n","type":"text/plain"},"type":"any","value":"code","key":"lookupKey"},{"description":{"content":"

The value of the key (id or code)

\n","type":"text/plain"},"type":"any","value":"3A21","key":"lookupValue"}]}},"response":[{"id":"e71394cc-b2b6-4285-9422-c567caecd16a","name":"Get Pricesheet by code - 200 (expands products, categories)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue?expands=products,categories","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"products,categories","description":"Optional. Use `products` and/ or `categories` to retrieve the pricing defined on product/ category level. By default, no pricing will be retrieved. \n\n[What is resource expanding?](#expanding-resources)"}],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A21","description":"The value of the key (id or code)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"3814"},{"key":"date","value":"Thu, 31 Mar 2022 17:29:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"20f0dfdf-9550-4ccf-a817-52a8d8e78199"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"pricing\": [\n {\n \"category\": {\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n }\n ],\n \"id\": 1779,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Fiets\"\n }\n ],\n \"pricing\": {\n \"validTo\": \"December, 31 2022 00:00:00 +0000\",\n \"validFrom\": \"May, 01 2022 00:00:00 +0000\",\n \"quantity\": 1,\n \"type\": \"CP\",\n \"amount\": 10\n }\n }\n },\n {\n \"product\": {\n \"eanCode\": \"0753759256211\",\n \"price\": 599.95,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1050 Fietscomputer\"\n }\n ],\n \"oemCode\": \"NCABD70005\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1050 Fietscomputer\"\n }\n ],\n \"shortName\": \"Edge 1050 Fietscomputer\",\n \"sku\": \"NCABD70005\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 0.21,\n \"supplierCode\": \"NCABD70005\",\n \"status\": \"A\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"id\": 40364,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\n }\n ],\n \"supplier\": \"TECHDATA\",\n \"pricing\": {\n \"validTo\": \"December, 31 2022 00:00:00 +0000\",\n \"validFrom\": \"May, 01 2022 00:00:00 +0000\",\n \"quantity\": 1,\n \"type\": \"SP\",\n \"amount\": 20\n }\n }\n },\n {\n \"product\": {\n \"eanCode\": \"0753759256289\",\n \"price\": 599.95,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n }\n ],\n \"oemCode\": \"NCABD70004\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Edge 1030 Fietscomputer\"\n }\n ],\n \"shortName\": \"Edge 1030 Fietscomputer\",\n \"sku\": \"NCABD70004\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 0.21,\n \"supplierCode\": \"NCABD70004\",\n \"status\": \"A\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"id\": 40362,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\n }\n ],\n \"supplier\": \"TECHDATA\",\n \"pricing\": {\n \"validTo\": \"December, 31 2022 00:00:00 +0000\",\n \"validFrom\": \"May, 01 2022 00:00:00 +0000\",\n \"price\": 4,\n \"quantity\": 2\n }\n }\n }\n ],\n \"code\": \"3A21\",\n \"shopId\": 1,\n \"name\": \"Pricesheet 3A21\",\n \"description\": \"\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"e53d1e8b-8899-42e3-9a5c-22926e3459ee","name":"Get Pricesheet by code - 200 (without expands)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"products,categories","description":"Optional. Use `products` and/ or `categories` to retrieve the pricing defined on product/ category level. By default, no pricing will be retrieved. \n\n[What is resource expanding?](#expanding-resources)","disabled":true}],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A21","description":"The value of the key (id or code)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"573"},{"key":"date","value":"Thu, 31 Mar 2022 17:34:03 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"a2e71016-be26-435c-a957-cf10b4c792f6"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"pricing\": [\n {\n \"category\": {\n \"pricing\": {\n \"validTo\": \"December, 31 2022 00:00:00 +0000\",\n \"validFrom\": \"May, 01 2022 00:00:00 +0000\",\n \"quantity\": 1,\n \"type\": \"CP\",\n \"amount\": 10\n },\n \"id\": 1779\n }\n },\n {\n \"product\": {\n \"pricing\": {\n \"validTo\": \"December, 31 2022 00:00:00 +0000\",\n \"validFrom\": \"May, 01 2022 00:00:00 +0000\",\n \"quantity\": 1,\n \"type\": \"SP\",\n \"amount\": 20\n },\n \"id\": 40364\n }\n },\n {\n \"product\": {\n \"pricing\": {\n \"validTo\": \"December, 31 2022 00:00:00 +0000\",\n \"validFrom\": \"May, 01 2022 00:00:00 +0000\",\n \"price\": 4,\n \"quantity\": 2\n },\n \"id\": 40362\n }\n }\n ],\n \"code\": \"3A21\",\n \"shopId\": 1,\n \"name\": \"Pricesheet 3A21\",\n \"description\": \"\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"775baa26-b149-4ea5-86c3-7981aa89b57a","name":"Get Pricesheet by id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"products,categories","description":"Optional. Use `products` and/ or `categories` to retrieve the pricing defined on product/ category level. By default, no pricing will be retrieved. \n\n[What is resource expanding?](#expanding-resources)","disabled":true}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"158","description":"The value of the key (id or code)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"170"},{"key":"date","value":"Thu, 31 Mar 2022 17:35:16 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"7a2f7cfc-bdd1-4be1-8579-92c7e7d0f074"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/12002\",\n \"messages\": [\n \"Pricesheet with id [158] not found\"\n ],\n \"status\": 404,\n \"code\": 12002,\n \"type\": \"PricesheetNotFound\"\n }\n}"}],"_postman_id":"2a3d7a96-f6bd-4787-b91c-223ea71533fc"},{"name":"Delete Pricesheet by lookup id","id":"b4563ca3-49d1-4ab8-8959-db33df43f8be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue","description":"

This endpoint deletes a price sheet and it's pricing. The price sheet can be identified by lookup key.

Lookup key. Read more about price sheet lookup keys

\n","type":"text/plain"},"type":"any","value":"code","key":"lookupKey"},{"description":{"content":"

The value of the key (id or code)

\n","type":"text/plain"},"type":"any","value":"3A22","key":"lookupValue"}]}},"response":[{"id":"543af29a-d3df-4524-8ba5-32bbf2451d75","name":"Delete Pricesheet by code - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A22","description":"The value of the key (id or code)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Thu, 31 Mar 2022 17:37:52 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e1f828f0-067d-4b98-bdbd-a79426881dc7"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"},{"id":"782b34d5-cb69-4cb3-9e09-ebdcaabc649a","name":"Delete Pricesheet by code - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A221","description":"The value of the key (id or code)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"174"},{"key":"date","value":"Thu, 31 Mar 2022 17:40:43 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"adce4eff-80c0-4036-8f0b-35d573673bc1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/12002\",\n \"messages\": [\n \"Pricesheet with code [3A221] not found\"\n ],\n \"status\": 404,\n \"code\": 12002,\n \"type\": \"PricesheetNotFound\"\n }\n}"}],"_postman_id":"b4563ca3-49d1-4ab8-8959-db33df43f8be"},{"name":"Delete Pricesheet Pricing","id":"a8e0a1db-016c-4b81-99bb-f6ec8e2d2c82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue/pricing","description":"

Use this endpoint to delete pricing for a given price sheet without actually deleting the price sheet. The price sheet is identified by lookup key.

Lookup key. Read more about price sheet lookup keys

\n","type":"text/plain"},"type":"any","value":"code","key":"lookupKey"},{"description":{"content":"

The value of the key (id or code)

\n","type":"text/plain"},"type":"any","value":"3A22","key":"lookupValue"}]}},"response":[{"id":"12062356-8fc0-4dea-bd26-6ac9cfc49d4c","name":"Delete Pricesheet Pricing - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A22","description":"The value of the key (id or code)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"38"},{"key":"date","value":"Thu, 31 Mar 2022 17:36:33 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"4ccc3d95-2c3b-4919-ab74-53e6dbb46e00"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"completed\"\n ]\n}"},{"id":"f160d16f-8153-416f-9e03-adcb35b2ec27","name":"Delete Pricesheet Pricing - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/pricesheets/:lookupKey/:lookupValue/pricing","host":["https://api.helice.cloud/api/g/v1"],"path":["pricesheets",":lookupKey",":lookupValue","pricing"],"variable":[{"key":"lookupKey","value":"code","description":"Lookup key. Read [more](#price-sheet-lookup-keys) about price sheet lookup keys"},{"key":"lookupValue","value":"3A221","description":"The value of the key (id or code)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"200"},{"key":"date","value":"Thu, 31 Mar 2022 17:37:07 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"cd235303-6610-4148-91a5-6773faf52479"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/12005\",\n \"messages\": [\n \"Parent resource [Pricesheets] with code [3A221] not found\"\n ],\n \"status\": 404,\n \"code\": 12005,\n \"type\": \"ParentPricesheetsNotFound\"\n }\n}"}],"_postman_id":"a8e0a1db-016c-4b81-99bb-f6ec8e2d2c82"}],"id":"c711ef4d-e5ef-407f-8959-922cc0160944","description":"

Price sheets are a common and quite familiar concept in the e-commerce world. A price sheet can include the prices for products or groups of products i.e. categories. A single price sheet can be assigned to multiple users. Check the Users endpoints to learn how to assign a pricesheet to a user.

Price Sheet Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller pricesheet id, auto-generated
code	string	Price sheet code

What are lookup keys?

Price sheet fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
code	Price sheet code	string integer
shopId	Identifies the shop the pricesheet will be valid for	integer
name	Price sheet name	string
description	Price sheet description	string

Pricing

Pricing for products and categories can be defined for different resources: pricesheet which can be assigned for a user or usergroup, or directly define pricing for user or usergroup.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
categories	List of categories and corresponding prices	array[PricingItem]
products	List of products and corresponding prices	array[PricingItem]
shopId	Identifies the shop the prices will be valid for. For pricesheet prices, `shopId` is inferred from pricesheet's `shopId`. For user type discounts, if not provided, a default one will be set (first shop found).	integer

Pricing Item

A pricing item identifies the resource for which the prices are defined. This resource can be a product or a category. The resource can be defined by either id or sourceId in combination with source. The pricing item also includes the price itself.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
id	Resource Id	integer
sourceId	Source Id	string
source	Source	string
pricing	Price	PricingElement

Pricing Element

This field represents the actual price definition.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
type	Price type Cost price plus (CP) = The cost price of a product + `amount` percent Sales price minus (SP) = The sales price of a product - `amount` percent Net = Net `price`	enum CP SP net
amount	Percent. Should be used in combination with `type` SP or CP.	decimal
price	Net price. Should be used when `type` is net.	decimal
quantity	The minimum quantity for which this price is valid	integer
validFrom	The price is valid after this date	date
validTo	The price is valid before this date	date

Pricesheet/ Pricing Errors

This section describes error codes specific for the Pricesheet and Pricingresources.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
12001	PricesheetExists	400	Pricesheet already exists	Pricesheet with such lookup key already exists
12002	PricesheetNotFound	404	Pricesheet not found	Pricesheet with such lookup key not found
12003	PricesheetPricingExists	400	Pricesheet already contains pricing	Pricesheet/ User/ Usergroup pricing already exists
12004	PricesheetPricingError	400	Error listing pricing	Error retrieveing pricing
12005	ParentPricesheetsNotFound	404	Parent resource pricesheet not found	Parent pricesheet with such lookup key not found. This error is typical when working with pricesheet pricing

","_postman_id":"c711ef4d-e5ef-407f-8959-922cc0160944","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Attributes","item":[{"name":"Get attributes","id":"df0aeba2-e2b3-4a3d-a110-ceef962cb7ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/attributes?page=1&offset=20","description":"

This endpoint can be used to list all existing attributes. Results will be paginated. The default number of attributes per page is 12, but can be up to 100.

Page number. integer, optional (default: 1)

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of results per page. integer, optional (default: 20)

\n","type":"text/plain"},"key":"offset","value":"20"}],"variable":[]}},"response":[{"id":"8a5c740e-2cf6-49d5-8665-4ae0e97476fc","name":"Get attributes - 200 (with results)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes?page=1&offset=20","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"offset","value":"20","description":"Number of results per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"5634"},{"key":"date","value":"Mon, 07 Mar 2022 14:42:16 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"3b9265b3-ddf0-956e-98e8-dd03f7983cf1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"AUTOMATIC_BILLING\",\n \"name\": \"AUTOMATIC_BILLING\",\n \"id\": 1,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"BILLABLE_HOURS_INTO_INVOICE\",\n \"name\": \"BILLABLE_HOURS_INTO_INVOICE\",\n \"id\": 2,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"BILLABLE_HOURS_RATE_TYPE\",\n \"name\": \"BILLABLE_HOURS_RATE_TYPE\",\n \"id\": 3,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"SEND_TICKET_ACTIVITY\",\n \"name\": \"SEND_TICKET_ACTIVITY\",\n \"id\": 4,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"AUTOMATIC_BILLING\",\n \"name\": \"AUTOMATIC_BILLING\",\n \"id\": 5,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"BILLABLE_HOURS_INTO_INVOICE\",\n \"name\": \"BILLABLE_HOURS_INTO_INVOICE\",\n \"id\": 6,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"BILLABLE_HOURS_RATE_TYPE\",\n \"name\": \"BILLABLE_HOURS_RATE_TYPE\",\n \"id\": 7,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"isHidden\": \"N\",\n \"defaultLanguage\": \"NL\",\n \"isSystem\": \"N\",\n \"typeParam\": \"SEND_TICKET_ACTIVITY\",\n \"name\": \"SEND_TICKET_ACTIVITY\",\n \"id\": 8,\n \"type\": \"enum\",\n \"class\": \"project\",\n \"isSearchable\": \"N\",\n \"group\": \"\",\n \"isPublic\": \"N\"\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_1\",\n \"id\": 11,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_1\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_2\",\n \"id\": 12,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_2\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_3\",\n \"id\": 13,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_3\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_4\",\n \"id\": 15,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_4\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_5\",\n \"id\": 16,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_5\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_6\",\n \"id\": 17,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_6\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_7\",\n \"id\": 18,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_7\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_PLUSPUNT_8\",\n \"id\": 19,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_PLUSPUNT_8\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"\"\n },\n {\n \"language\": \"FR\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_MINPUNT_1\",\n \"id\": 20,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_MINPUNT_1\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"PROPELLOR_MINPUNT_1\"\n },\n {\n \"language\": \"FR\",\n \"value\": \"PROPELLOR_MINPUNT_1\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_MINPUNT_2\",\n \"id\": 21,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_MINPUNT_2\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_MINPUNT_3\",\n \"id\": 22,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_MINPUNT_3\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n },\n {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"PROPELLOR_MINPUNT_4\",\n \"id\": 23,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"PROPELLOR_MINPUNT_4\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": false\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 11,\n \"total\": 20,\n \"offset\": 20,\n \"itemsFound\": 208,\n \"end\": 20,\n \"page\": 1\n}"},{"id":"aa83606a-1aaf-4350-b411-1b9e44a6b3b1","name":"Get attributes - 200 (no results)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes?page=15&offset=20","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes"],"query":[{"key":"page","value":"15","description":"Page number"},{"key":"offset","value":"20","description":"Number of results per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"98"},{"key":"date","value":"Mon, 07 Mar 2022 16:33:22 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"94282b6d-d35a-4285-bb10-897622ead1cb"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"messages\": [\n \"Completed\"\n ],\n \"pages\": 11,\n \"total\": 1,\n \"offset\": 20,\n \"itemsFound\": 208,\n \"page\": 15\n}"},{"id":"625db842-2da9-446c-91cb-eb14bd2f1032","name":"Get attributes - 400 (invalid offset)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes?page=1&offset=150","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"offset","value":"150","description":"Number of results per page"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"174"},{"key":"date","value":"Mon, 07 Mar 2022 16:34:31 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"e7215195-6372-4222-ad37-40974a53b10b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10015\",\n \"messages\": [\n \"Offset cannot be more than 100\"\n ],\n \"status\": 400,\n \"code\": 10015,\n \"type\": \"PaginatedResponseException\"\n }\n}"}],"_postman_id":"df0aeba2-e2b3-4a3d-a110-ceef962cb7ce"},{"name":"Create attribute","id":"57069a51-f5aa-4410-b42b-adec2bb520f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"COLOR\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Kleur\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Color\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"class\": \"product\",\r\n \"type\": \"enum\",\r\n \"typeParam\": \"COLORS\",\r\n \"group\": \"\",\r\n \"value\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/attributes","description":"

Before setting an attribute value for a specific resource, the attribute definition needs to be created. This endpoint is used to create a single attribute definition.

If an attribute is successfully created, the response will include the attribute id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
name	yes
class	yes
isPublic	no Default value is `true`
isSearchable	no Default value is `false`
isSystem	no Default value is `false`
isHidden	no Default value is `false`
type	yes
typeParam	only when `type` value is `enum` or `enumlist`
descriptions	no
value	only when `type` is `integer`, `decimal`, `date` or `datetime`
units	no
group	no

This endpoint enables updating the definition of an attribute. The attribute is identified by it's Propeller ID or name. The attributeClass Query Param is useful to use when the same attribute name is used for an attribute with a different class.

Attribute class. Optional. Used in combination with lookup key name. Possible values are product, category, user

\n","type":"text/plain"},"key":"attributeClass","value":"product"}],"variable":[{"description":{"content":"

Lookup key. Use id or name

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or name of the attribute

\n","type":"text/plain"},"type":"any","value":"668","key":"lookupValue"}]}},"response":[{"id":"594fcb0a-327f-4578-9330-6d40fdfe74e4","name":"Update attribute by id - 200","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Kleur\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Color\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"group\": \"\",\r\n \"value\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/attributes/id/668"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"242"},{"key":"date","value":"Mon, 07 Mar 2022 16:17:09 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"edca80e3-948d-4305-907d-8edff327e2d0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Kleur\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Color\"\n }\n ],\n \"isPublic\": true,\n \"isSearchable\": false,\n \"isHidden\": false,\n \"isSystem\": false,\n \"group\": \"\",\n \"value\": \"\",\n \"id\": 668\n },\n \"messages\": [\n \"Attribute updated\"\n ],\n \"total\": 1\n}"},{"id":"fb741f7a-9d8c-47d5-9125-1867591d4cb3","name":"Update attribute by id - 404","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Kleur\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Color\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"group\": \"\",\r\n \"value\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/attributes/id/800"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"169"},{"key":"date","value":"Mon, 07 Mar 2022 16:18:45 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"94e11a38-59ea-4a70-87cd-f33d68f4e926"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with id [800] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"},{"id":"f65ec1f0-1903-4924-828b-ff9cc196f5ee","name":"Update attribute by name and class - 200","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Kleur\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Color\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"group\": \"\",\r\n \"value\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes/name/COLOR?attributeClass=product","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes","name","COLOR"],"query":[{"key":"attributeClass","value":"product","description":"Attribute class"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"242"},{"key":"date","value":"Mon, 07 Mar 2022 16:19:39 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"7e399cb8-ddff-4a1f-a0ef-04edaec18600"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Kleur\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Color\"\n }\n ],\n \"isPublic\": true,\n \"isSearchable\": false,\n \"isHidden\": false,\n \"isSystem\": false,\n \"group\": \"\",\n \"value\": \"\",\n \"id\": 668\n },\n \"messages\": [\n \"Attribute updated\"\n ],\n \"total\": 1\n}"},{"id":"90f78814-64d9-4824-8660-587c3af3ec98","name":"Update attribute by name and class - 404","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Kleur\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Color\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"group\": \"\",\r\n \"value\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes/name/COLOR?attributeClass=category","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes","name","COLOR"],"query":[{"key":"attributeClass","value":"category","description":"Attribute class"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"203"},{"key":"date","value":"Mon, 07 Mar 2022 16:20:24 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"7dd29b63-5541-460b-9826-fadae75be9be"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with name [COLOR] and attributeClass [category] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"},{"id":"757e4235-9b21-4c55-b4d5-3999248ad58a","name":"Update attribute by name and class - 400 (invalid value)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Kleur\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Color\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"group\": \"\",\r\n \"value\": []\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes/name/COLOR?attributeClass=product","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes","name","COLOR"],"query":[{"key":"attributeClass","value":"product","description":"Attribute class"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"188"},{"key":"date","value":"Mon, 07 Mar 2022 16:21:13 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"6863900a-d410-4a30-a829-05e448ded69c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14005\",\n \"messages\": [\n \"Invalid value provided. Attribute type is [enum].\"\n ],\n \"status\": 400,\n \"code\": 14005,\n \"type\": \"AttributeInvalidValue\"\n }\n}"}],"_postman_id":"8bbf2228-e392-4e0c-9a89-a99ff0e9499e"},{"name":"Get attribute by lookup key","id":"499693b3-3fa1-4f65-89dd-451e30367afc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/attributes/:lookupKey/:lookupValue?attributeClass=product","description":"

This endpoint is used to retrieve details of an attribute. The attribute is identified by it's Propeller ID or name. The attributeClass Query Param is useful to use when the same attribute name is used for an attribute with a different class.

Attribute class. Optional. Used in combination with lookup key name. Possible values are product, category, user

\n","type":"text/plain"},"key":"attributeClass","value":"product"}],"variable":[{"description":{"content":"

Lookup key. Use id or name

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or name of the attribute

\n","type":"text/plain"},"type":"any","value":"668","key":"lookupValue"}]}},"response":[{"id":"0b86c109-b6f9-45f7-b02b-5207c4b1d72c","name":"Get attribute by id - 200","originalRequest":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/attributes/id/668"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"382"},{"key":"date","value":"Mon, 07 Mar 2022 16:14:15 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"84d53fe4-732f-4d18-83bb-439e94d0b298"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"units\": [\n {\n \"language\": \"EN\",\n \"value\": \"\"\n },\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"EN\",\n \"isSystem\": false,\n \"typeParam\": \"COLORS\",\n \"name\": \"COLOR\",\n \"id\": 668,\n \"type\": \"enum\",\n \"value\": \"\",\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"EN\",\n \"value\": \"Color\"\n },\n {\n \"language\": \"NL\",\n \"value\": \"Kleur\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": true\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"45637598-6b07-4775-a23e-7e937716864d","name":"Get attribute by id - 404","originalRequest":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/attributes/id/800"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"169"},{"key":"date","value":"Mon, 07 Mar 2022 16:14:57 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"ed0c0c88-e709-4bfc-89bd-fe2a2e94cf9c"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with id [800] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"},{"id":"6e76cb63-9fb4-466a-984d-6cbb22aafcae","name":"Get attribute by name and class - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes/name/MATERIAAL_FRAME?attributeClass=product","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes","name","MATERIAAL_FRAME"],"query":[{"key":"attributeClass","value":"product","description":"Attribute class"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"403"},{"key":"date","value":"Mon, 07 Mar 2022 14:58:58 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"026fec00-dafe-43bb-843d-d84cfd590683"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"units\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"\"\n }\n ],\n \"isHidden\": false,\n \"defaultLanguage\": \"NL\",\n \"isSystem\": false,\n \"typeParam\": \"\",\n \"name\": \"MATERIAAL_FRAME\",\n \"id\": 85,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\",\n \"isSearchable\": false,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Framemateriaal\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Frame material\"\n }\n ],\n \"group\": \"\",\n \"isPublic\": true\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"34edb237-0413-4abe-9005-3aa234e28418","name":"Get attribute by name and class - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes/name/MATERIAAL_FRAME?attributeClass=category","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes","name","MATERIAAL_FRAME"],"query":[{"key":"attributeClass","value":"category","description":"Attribute class"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"213"},{"key":"date","value":"Mon, 07 Mar 2022 14:59:41 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"7a690144-65d6-40f8-8d8b-0ce4589da991"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with name [MATERIAAL_FRAME] and attributeClass [category] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"}],"_postman_id":"499693b3-3fa1-4f65-89dd-451e30367afc"},{"name":"Delete attribute by lookup key","id":"a0c64836-b0a8-4615-bbc5-d360f75071c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/attributes/:lookupKey/:lookupValue?attributeClass=product","description":"

This endpoint is used to delete an attribute. The attribute is identified by it's Propeller ID or name. The attributeClass Query Param is useful to use when the same attribute name is used for an attribute with a different class.

When an attribute is deleted all the values set on resources (products, users, etc.) will be deleted as well.

Attribute class. Optional. Used in combination with lookup key name. Possible values are product, category, user

\n","type":"text/plain"},"key":"attributeClass","value":"product"}],"variable":[{"description":{"content":"

Lookup key. Use id or name

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The id or name of the attribute

\n","type":"text/plain"},"type":"any","value":"668","key":"lookupValue"}]}},"response":[{"id":"0cc790d3-6093-42b7-b307-8dfd83174411","name":"Delete attribute by id - 200","originalRequest":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/attributes/id/85"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"46"},{"key":"date","value":"Mon, 07 Mar 2022 15:54:29 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"791f63fc-8760-42b8-bd2c-679b17e979fc"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Attribute deleted\"\n ]\n}"},{"id":"2793ec64-e57a-4791-ae8e-90c2158c1bd5","name":"Delete attribute by id - 404","originalRequest":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/attributes/id/85"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"168"},{"key":"date","value":"Mon, 07 Mar 2022 15:55:10 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"a1f8184f-4a47-4d2f-b974-5fe0262d00b2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with id [85] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"},{"id":"d8d11127-0422-4214-a830-260dbec39288","name":"Delete attribute by name and class - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes/name/COLOR?attributeClass=product","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes","name","COLOR"],"query":[{"key":"attributeClass","value":"product","description":"Attribute class"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"46"},{"key":"date","value":"Mon, 07 Mar 2022 14:53:00 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"940ff23c-8c5d-4d9a-b533-408e456a960f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Attribute deleted\"\n ]\n}"},{"id":"e5bf82dd-adde-467e-b934-564ccfa611eb","name":"Delete attribute by name and class - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/attributes/name/COLOR?attributeClass=product","host":["https://api.helice.cloud/api/g/v1"],"path":["attributes","name","COLOR"],"query":[{"key":"attributeClass","value":"product","description":"Attribute class"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"202"},{"key":"date","value":"Mon, 07 Mar 2022 14:53:36 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"da6ad28e-989d-4ac2-a52c-a499b9944219"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with name [COLOR] and attributeClass [product] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"}],"_postman_id":"a0c64836-b0a8-4615-bbc5-d360f75071c4"},{"name":"Bulk attributes by id","id":"a1078979-256c-4e36-a83c-2e05af438b0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 644,\r\n \"name\": \"WEIGHT\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Gewicht\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Weight\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"typeParam\": \"\",\r\n \"group\": \"\",\r\n \"units\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"kg\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"kg\"\r\n }\r\n ],\r\n \"value\": 0\r\n },\r\n {\r\n \"id\": 0,\r\n \"name\": \"MATERIAAL_FRAME\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Framemateriaal\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Frame material\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"typeParam\": \"\",\r\n \"group\": \"\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": 0,\r\n \"name\": \"COLOR\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Kleur\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Color\"\r\n }\r\n ],\r\n \"isPublic\": true,\r\n \"isSearchable\": false,\r\n \"isHidden\": false,\r\n \"isSystem\": false,\r\n \"class\": \"product\",\r\n \"type\": \"enum\",\r\n \"typeParam\": \"COLORS\",\r\n \"group\": \"\",\r\n \"value\": \"\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/attributes/bulk/id","description":"

Before setting an attribute value for a specific resource, the attribute definition needs to be created. Usually, multiple attributes need to be created or updated at the same time which is useful to eliminate a lot of API requests. This endpoint is used for bulk processing of attribute definitions based on an ID.

The id field is required and when it is 0 a new attribute will be created, otherwise the attribute definition will be updated. When updating, although part of the request body, the fields name, class and type are ignored.

The name field is required and if an attribute with the provided name and class is not found it will be created, otherwise the attribute definition will be updated. When updating, although part of the request body, the fields name, class and type are ignored.

Retrieves a list of attributes by using the search fields below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
ids	array(int)
names	array(string)
class	string
isPublic	boolean
isSearchable	boolean
isHidden	boolean
isSystem	boolean
offset	int (max: 100)
page	int

Results will be paginated. The default number of attributes per page is 12, but can be up to 100.

Retrieves all attributes for a resource identified by its lookup key. Results will be paginated. The default number of attributes per page is 12, but can be up to 100.
A resource can be a product, category, user or usergroup.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
id	Attribute ID
name	Attribute name
type	Type of the value of the attribute
class	Attribute class
value	Attribute value for the product. Depends on the type.
inherited	Boolean. Indicates whether the value is directly set on the product or inherited from a parent resource. For `text` and `list` type attributes, `inherited` is part of the localized string for each language,

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of results per page

\n","type":"text/plain"},"key":"offset","value":"50"},{"disabled":true,"description":{"content":"

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"RESTAPI"}],"variable":[{"description":{"content":"

Resource type. Possible values are products, categories, users, usergroups

\n","type":"text/plain"},"type":"any","value":"usergroups","key":"resourceType"},{"description":{"content":"

Lookup key. Use different lookup keys depending on the resource type

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (an id, sourceId, sku, etc.)

\n","type":"text/plain"},"type":"any","value":"109","key":"lookupValue"}]}},"response":[{"id":"40c111e4-6b1a-4397-8cd7-1c15246cdf89","name":"Get product attributes by product id - 200 (with results)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/id/37221/attributes?page=1&offset=50","host":["https://api.helice.cloud/api/g/v1"],"path":["products","id","37221","attributes"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"offset","value":"50","description":"Number of results per page"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"6190"},{"key":"date","value":"Tue, 08 Mar 2022 10:13:36 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"44678b25-c42d-4e77-952d-17f3ae62aed8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"PROPELLOR_PLUSPUNT_1\",\n \"id\": 11,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": false,\n \"value\": \"Pluspunt test NL\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PLUSPUNT_2\",\n \"id\": 12,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": false,\n \"value\": \"De stoel is compact in te klappen zodat je hem gemakkelijk meeneemt.\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PLUSPUNT_3\",\n \"id\": 13,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PLUSPUNT_4\",\n \"id\": 15,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PLUSPUNT_5\",\n \"id\": 16,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PLUSPUNT_6\",\n \"id\": 17,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PLUSPUNT_7\",\n \"id\": 18,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PLUSPUNT_8\",\n \"id\": 19,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_1\",\n \"id\": 20,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": false,\n \"value\": \"De stoel heeft geen verstelbare rugleuning.\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_2\",\n \"id\": 21,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_3\",\n \"id\": 22,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_4\",\n \"id\": 23,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_5\",\n \"id\": 24,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_6\",\n \"id\": 25,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_7\",\n \"id\": 26,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MINPUNT_8\",\n \"id\": 27,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_LABEL_1\",\n \"id\": 28,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_LABEL_2\",\n \"id\": 29,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"META_DESCRIPTION_MASK\",\n \"id\": 45,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"EN\",\n \"inherited\": true,\n \"value\": \"Buy your {product_name} at {shop_name}. {product_description_plain , 60}.\"\n },\n {\n \"language\": \"FR\",\n \"inherited\": true,\n \"value\": \"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}.\"\n },\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}.\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"META_TITLE_MASK\",\n \"id\": 46,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"EN\",\n \"inherited\": true,\n \"value\": \"Shop your {product_name , 40} | {shop_name}\"\n },\n {\n \"language\": \"FR\",\n \"inherited\": true,\n \"value\": \"Koop uw {product_name , 40} | {shop_name}\"\n },\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Koop uw {product_name , 40} | {shop_name}\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_SALE\",\n \"id\": 66,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"product\"\n },\n {\n \"name\": \"VALUEPOINTS_WAARDE\",\n \"id\": 67,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"product\"\n },\n {\n \"name\": \"MATERIAAL_BINNENTENT\",\n \"id\": 68,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"BESTAND_TEGEN\",\n \"id\": 73,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"CAPACITEIT\",\n \"id\": 75,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"BREEDTE\",\n \"id\": 77,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"GEWICHT\",\n \"id\": 78,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"DIEPTE\",\n \"id\": 82,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"HOOGTE\",\n \"id\": 95,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"SONAR_WATERPROOF\",\n \"id\": 121,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"\",\n \"class\": \"product\"\n },\n {\n \"name\": \"SHOP_IN_KLEUR\",\n \"id\": 139,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"SHOP_IN_SERIE\",\n \"id\": 140,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_KLEUR\",\n \"id\": 164,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_MAAT\",\n \"id\": 165,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_A\",\n \"id\": 167,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_B\",\n \"id\": 168,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Vandaag besteld, [[day_of_week]] in huis\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_C\",\n \"id\": 169,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Verwachte levering binnen [[days]] dagen\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_D\",\n \"id\": 170,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Verwachte levering binnen [[weeks]] weken\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_E\",\n \"id\": 171,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Let op, lange levertijd\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_F\",\n \"id\": 172,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Dit product is niet leverbaar\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_G\",\n \"id\": 173,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Dit product is tijdelijk niet leverbaar\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_H\",\n \"id\": 174,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Dit product wordt geleverd op [[release_date]]\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_I\",\n \"id\": 175,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"inherited\": true,\n \"value\": \"Dit product is niet meer leverbaar\"\n }\n ],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_J\",\n \"id\": 176,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"DELIVERY_PROMISE_K\",\n \"id\": 177,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PRODUCT_FORMULA\",\n \"id\": 179,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"PROPELLOR_PACKAGE\",\n \"id\": 193,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"product\"\n },\n {\n \"name\": \"NUMERIC_DEMO\",\n \"id\": 641,\n \"inherited\": true,\n \"type\": \"integer\",\n \"value\": 0,\n \"class\": \"product\"\n },\n {\n \"name\": \"DECIMAL_DEMO\",\n \"id\": 642,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"product\"\n },\n {\n \"name\": \"DATETIME_DEMO\",\n \"id\": 643,\n \"type\": \"datetime\",\n \"class\": \"product\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 3,\n \"total\": 50,\n \"offset\": 50,\n \"itemsFound\": 108,\n \"end\": 50,\n \"page\": 1\n}"},{"id":"ad266287-6c7d-4eca-93b8-620c81838622","name":"Get product attributes by product id - 200 (no results)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/id/37221/attributes?page=5&offset=50","host":["https://api.helice.cloud/api/g/v1"],"path":["products","id","37221","attributes"],"query":[{"key":"page","value":"5","description":"Page number"},{"key":"offset","value":"50","description":"Number of results per page"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"96"},{"key":"date","value":"Tue, 08 Mar 2022 10:41:45 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"421d6da0-5b56-4e8f-bef6-64359c13aca4"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"messages\": [\n \"Completed\"\n ],\n \"pages\": 3,\n \"total\": 1,\n \"offset\": 50,\n \"itemsFound\": 108,\n \"page\": 5\n}"},{"id":"088725d6-bab4-4092-81e1-06f269013bb2","name":"Get product attributes by product id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/id/372212/attributes?page=5&offset=50","host":["https://api.helice.cloud/api/g/v1"],"path":["products","id","372212","attributes"],"query":[{"key":"page","value":"5","description":"Page number"},{"key":"offset","value":"50","description":"Number of results per page"},{"key":"source","value":"RESAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 08 Mar 2022 11:33:25 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"80497ba7-9ace-4185-946f-7b1752d7b16a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10009\",\n \"messages\": [\n \"Parent resource [Product] with id [372212] not found.\"\n ],\n \"status\": 404,\n \"code\": 10009,\n \"type\": \"ParentProductNotFound\"\n }\n}"},{"id":"a77dc22c-52ce-4114-93b7-7742d49483ca","name":"Get product attributes by product id - 400 (invalid page or offset)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/products/id/37221/attributes?page=5&offset=150","host":["https://api.helice.cloud/api/g/v1"],"path":["products","id","37221","attributes"],"query":[{"key":"page","value":"5","description":"Page number"},{"key":"offset","value":"150","description":"Number of results per page"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"174"},{"key":"date","value":"Tue, 08 Mar 2022 11:51:35 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"d5416483-9bbf-41e9-a16c-5661f7b24719"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10015\",\n \"messages\": [\n \"Offset cannot be more than 100\"\n ],\n \"status\": 400,\n \"code\": 10015,\n \"type\": \"PaginatedResponseException\"\n }\n}"},{"id":"a6f83cb3-96e7-430e-aa6e-37b059270ff1","name":"Get user attributes by user id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes?page=1&offset=50","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"offset","value":"50","description":"Number of results per page"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"users","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"14719","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"4176"},{"key":"date","value":"Mon, 14 Mar 2022 12:09:15 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"977bdbc1-b112-4e60-9619-8e0e6e0050e2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"REKENING\",\n \"id\": 47,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 1.6,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_REKENING\",\n \"id\": 48,\n \"inherited\": false,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"CONTANT\",\n \"id\": 49,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_CONTANT\",\n \"id\": 50,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_IDEAL\",\n \"id\": 54,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_IDEAL\",\n \"id\": 63,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_MASTERCARD\",\n \"id\": 64,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_MASTERCARD\",\n \"id\": 65,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_VISA\",\n \"id\": 125,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_VISA\",\n \"id\": 126,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_AMERICAN EXPRESS\",\n \"id\": 127,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_AMERICAN EXPRESS\",\n \"id\": 128,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"PAYPAL\",\n \"id\": 129,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_PAYPAL\",\n \"id\": 130,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_PAYAFTER\",\n \"id\": 131,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_PAYAFTER\",\n \"id\": 132,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"INCASSO\",\n \"id\": 133,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_INCASSO\",\n \"id\": 134,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_DIRECTBANK\",\n \"id\": 629,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_MISTERCASH\",\n \"id\": 630,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_DIRDEB\",\n \"id\": 631,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_GIROPAY\",\n \"id\": 632,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_BANKTRANS\",\n \"id\": 633,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_AMEX\",\n \"id\": 634,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_SOFORT\",\n \"id\": 635,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_MAESTRO\",\n \"id\": 636,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.REKENING\",\n \"id\": 141,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_AMERICAN EXPRESS\",\n \"id\": 142,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_IDEAL\",\n \"id\": 143,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_MASTERCARD\",\n \"id\": 144,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_PAYAFTER\",\n \"id\": 145,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_VISA\",\n \"id\": 146,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"CREDIT_LIMIT\",\n \"id\": 153,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"CREDIT_LIMIT_INTERVAL\",\n \"id\": 154,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"month\",\n \"class\": \"user\"\n },\n {\n \"name\": \"FI_DEFAULT_BUDGET_GROUP\",\n \"id\": 155,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"8010\",\n \"class\": \"user\"\n },\n {\n \"name\": \"PROPELLOR_USER_FORMULA\",\n \"id\": 178,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"user\"\n },\n {\n \"name\": \"EDIT_DELIVERY_ADDRESS\",\n \"id\": 182,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"EDIT_INVOICE_ADDRESS\",\n \"id\": 183,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"EC.viewUsergroupOrders\",\n \"id\": 184,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n },\n {\n \"name\": \"PAY_WITH_CREDITPOINTS\",\n \"id\": 626,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 1,\n \"total\": 40,\n \"offset\": 50,\n \"itemsFound\": 40,\n \"end\": 40,\n \"page\": 1\n}"},{"id":"5f4f63f5-0879-4bf0-8e8f-4de36193db76","name":"Get user attributes by user id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes?page=1&offset=50","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"offset","value":"50","description":"Number of results per page"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"users","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"14123","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"185"},{"key":"date","value":"Mon, 14 Mar 2022 12:09:58 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"43c4015f-9ea5-4ff9-b2c2-a243179db9d2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/90008\",\n \"messages\": [\n \"Parent resource [User] with id [14123] not found.\"\n ],\n \"status\": 404,\n \"code\": 90008,\n \"type\": \"ParentUserNotFound\"\n }\n}"},{"id":"cb35a16e-f448-40ad-b576-e903abfae8af","name":"Get usergroup attributes by usergroup id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes?page=1&offset=50","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"offset","value":"50","description":"Number of results per page"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"usergroups","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"109","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"4176"},{"key":"date","value":"Mon, 14 Mar 2022 12:11:15 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"8ef1f77a-fa1c-402e-a90c-9761af2cbf4b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"REKENING\",\n \"id\": 47,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 1.6,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_REKENING\",\n \"id\": 48,\n \"inherited\": false,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"CONTANT\",\n \"id\": 49,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_CONTANT\",\n \"id\": 50,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_IDEAL\",\n \"id\": 54,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_IDEAL\",\n \"id\": 63,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_MASTERCARD\",\n \"id\": 64,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_MASTERCARD\",\n \"id\": 65,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_VISA\",\n \"id\": 125,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_VISA\",\n \"id\": 126,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_AMERICAN EXPRESS\",\n \"id\": 127,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_AMERICAN EXPRESS\",\n \"id\": 128,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"PAYPAL\",\n \"id\": 129,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_PAYPAL\",\n \"id\": 130,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"MULTISAFEPAY_PAYAFTER\",\n \"id\": 131,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_PAYAFTER\",\n \"id\": 132,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"INCASSO\",\n \"id\": 133,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 99999.99999,\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_INCASSO\",\n \"id\": 134,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_DIRECTBANK\",\n \"id\": 629,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_MISTERCASH\",\n \"id\": 630,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_DIRDEB\",\n \"id\": 631,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_GIROPAY\",\n \"id\": 632,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_BANKTRANS\",\n \"id\": 633,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_AMEX\",\n \"id\": 634,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_SOFORT\",\n \"id\": 635,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"SHOW_MULTISAFEPAY_MAESTRO\",\n \"id\": 636,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.REKENING\",\n \"id\": 141,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_AMERICAN EXPRESS\",\n \"id\": 142,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_IDEAL\",\n \"id\": 143,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_MASTERCARD\",\n \"id\": 144,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_PAYAFTER\",\n \"id\": 145,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"mobileapp.MULTISAFEPAY_VISA\",\n \"id\": 146,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"CREDIT_LIMIT\",\n \"id\": 153,\n \"inherited\": true,\n \"type\": \"decimal\",\n \"value\": 0,\n \"class\": \"user\"\n },\n {\n \"name\": \"CREDIT_LIMIT_INTERVAL\",\n \"id\": 154,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"month\",\n \"class\": \"user\"\n },\n {\n \"name\": \"FI_DEFAULT_BUDGET_GROUP\",\n \"id\": 155,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"8010\",\n \"class\": \"user\"\n },\n {\n \"name\": \"PROPELLOR_USER_FORMULA\",\n \"id\": 178,\n \"type\": \"text\",\n \"value\": [],\n \"class\": \"user\"\n },\n {\n \"name\": \"EDIT_DELIVERY_ADDRESS\",\n \"id\": 182,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"EDIT_INVOICE_ADDRESS\",\n \"id\": 183,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n {\n \"name\": \"EC.viewUsergroupOrders\",\n \"id\": 184,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n },\n {\n \"name\": \"PAY_WITH_CREDITPOINTS\",\n \"id\": 626,\n \"inherited\": true,\n \"type\": \"enum\",\n \"value\": \"N\",\n \"class\": \"user\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"start\": 1,\n \"pages\": 1,\n \"total\": 40,\n \"offset\": 50,\n \"itemsFound\": 40,\n \"end\": 40,\n \"page\": 1\n}"}],"_postman_id":"96c99a65-6a61-4c2c-b280-21a6e047cb1f"},{"name":"Get resource attribute by resource lookup key and attribute lookup key","id":"a58cd982-bfa8-4bdf-8939-1177eb4f99fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes/:attributeLookupKey/:attributeLookupValue?attributeClass=product","description":"

Retrieves a specific attribute for a resource identified by resource lookup key and attribute lookup key. The attributeClass Query Param is useful to use when the attribute lookup key is name and the same attribute name is used for an attribute with a different class.

Attribute class. Optional. Used in combination with attribute lookup key name. Possible values are product, category, user

\n","type":"text/plain"},"key":"attributeClass","value":"product"},{"disabled":true,"description":{"content":"

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"RESTAPI"}],"variable":[{"description":{"content":"

Resource type. Possible values are products, categories, users, usergroups

\n","type":"text/plain"},"type":"any","value":"products","key":"resourceType"},{"description":{"content":"

Lookup key. Use different lookup keys depending on the resource type

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (an id, sourceId, sku, etc.)

\n","type":"text/plain"},"type":"any","value":"37221","key":"lookupValue"},{"description":{"content":"

Lookup key. Use id or name

\n","type":"text/plain"},"type":"any","value":"id","key":"attributeLookupKey"},{"description":{"content":"

The id or name of the attribute

\n","type":"text/plain"},"type":"any","value":"668","key":"attributeLookupValue"}]}},"response":[{"id":"c11e7d43-6ea0-4608-90ba-7117749f6cc9","name":"Get product attribute by product id and attribute id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes/:attributeLookupKey/:attributeLookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes",":attributeLookupKey",":attributeLookupValue"],"query":[{"key":"attributeClass","value":"product","disabled":true},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"37221","description":"The value of the key (an id, sourceId, sku, etc.)"},{"key":"attributeLookupKey","value":"id","description":"Lookup key. Use `id` or `name`"},{"key":"attributeLookupValue","value":"671","description":"The `id` or `name` of the attribute"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"228"},{"key":"date","value":"Mon, 14 Mar 2022 12:17:23 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"1e0d0e19-acfe-4919-b329-9e39b9760c7a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"name\": \"MATERIAAL_FRAME\",\n \"id\": 671,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"EN\",\n \"inherited\": false,\n \"value\": \"Leather\"\n },\n {\n \"language\": \"NL\",\n \"inherited\": false,\n \"value\": \"Leer\"\n }\n ],\n \"class\": \"product\"\n },\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 1\n}"},{"id":"5ca5cc86-fdd3-471a-a7dd-19c6b646ebb4","name":"Get product attribute by product id and attribute name/ class - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes/:attributeLookupKey/:attributeLookupValue?attributeClass=product","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes",":attributeLookupKey",":attributeLookupValue"],"query":[{"key":"attributeClass","value":"product","description":"Attribute class. Optional. Used in combination with attribute lookup key `name`. Possible values are `product`, `category`, `user`"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"37221","description":"The value of the key (an id, sourceId, sku, etc.)"},{"key":"attributeLookupKey","value":"name","description":"Lookup key. Use `id` or `name`"},{"key":"attributeLookupValue","value":"MATERIAAL_FRAME","description":"The `id` or `name` of the attribute"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"228"},{"key":"date","value":"Mon, 14 Mar 2022 12:18:24 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"327c4535-ffc2-419f-9ed8-42b9255b89b8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"name\": \"MATERIAAL_FRAME\",\n \"id\": 671,\n \"type\": \"text\",\n \"value\": [\n {\n \"language\": \"EN\",\n \"inherited\": false,\n \"value\": \"Leather\"\n },\n {\n \"language\": \"NL\",\n \"inherited\": false,\n \"value\": \"Leer\"\n }\n ],\n \"class\": \"product\"\n },\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 1\n}"},{"id":"2d399d38-e78c-4552-b875-0aecf14f0ac7","name":"Get product attribute by product id and attribute name/ class - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes/:attributeLookupKey/:attributeLookupValue?attributeClass=product","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes",":attributeLookupKey",":attributeLookupValue"],"query":[{"key":"attributeClass","value":"product","description":"Attribute class. Optional. Used in combination with attribute lookup key `name`. Possible values are `product`, `category`, `user`"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"37221","description":"The value of the key (an id, sourceId, sku, etc.)"},{"key":"attributeLookupKey","value":"name","description":"Lookup key. Use `id` or `name`"},{"key":"attributeLookupValue","value":"FRAME","description":"The `id` or `name` of the attribute"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"202"},{"key":"date","value":"Mon, 14 Mar 2022 12:20:04 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"3badf180-4f37-4c65-aa7d-80f7a619cf69"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with name [FRAME] and attributeClass [product] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"},{"id":"bc1ae08b-2d7e-4f84-af03-b11ced55f00c","name":"Get user attribute by user id and attribute name/ class - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes/:attributeLookupKey/:attributeLookupValue?attributeClass=user","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes",":attributeLookupKey",":attributeLookupValue"],"query":[{"key":"attributeClass","value":"user","description":"Attribute class. Optional. Used in combination with attribute lookup key `name`. Possible values are `product`, `category`, `user`"},{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"users","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"14719","description":"The value of the key (an id, sourceId, sku, etc.)"},{"key":"attributeLookupKey","value":"name","description":"Lookup key. Use `id` or `name`"},{"key":"attributeLookupValue","value":"SHOW_REKENING","description":"The `id` or `name` of the attribute"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"137"},{"key":"date","value":"Mon, 14 Mar 2022 12:21:39 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"556612fa-7597-4b90-b8ac-2e4a90e90604"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"name\": \"SHOW_REKENING\",\n \"id\": 48,\n \"inherited\": false,\n \"type\": \"enum\",\n \"value\": \"Y\",\n \"class\": \"user\"\n },\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 1\n}"}],"_postman_id":"a58cd982-bfa8-4bdf-8939-1177eb4f99fa"},{"name":"Bulk resource attribute values by resource lookup key","id":"d0bf4d6a-5928-4fd8-b50d-3ac1d227829f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"WEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"value\": 15\r\n },\r\n {\r\n \"name\": \"MATERIAAL_FRAME\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Leer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Leather\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"HEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"enum\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes?source=RESTAPI","description":"

The bulk resource attribute endpoint sets/ deletes resource attributes for a single resource identified by the lookup key. The attribute is identified via the payload by providing either id or name. If both are provided, id will be used to identify the attribute. Below is a summary of all the possible fields in the payload.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
id	yes, if `name` not provided
name	yes, if `id` not specified
class	yes, if `id` not specified
type	yes
value	no, if omitted the attribute value will be deleted for the resource (set to default)

A successful response contains data about each attribute changes: whether the attribute was created/ updated for that resource, in which case the action in the response will be put, or delete if the value of the attribute for the particular resource is being deleted. After it is deleted, the attribute value for the specific resource will inherit the value from the parent resource(s).

In case of an issue, the data will contain a message explaining the reason, for ex. when an attribute is not found, or the value provided does not match the attribute type, etc.

Optional. Used in combination with lookup key sourceId

\n","type":"text/plain"},"key":"source","value":"RESTAPI"}],"variable":[{"description":{"content":"

Resource type. Possible values are products, categories, users, usergroups

\n","type":"text/plain"},"type":"any","value":"products","key":"resourceType"},{"description":{"content":"

Lookup key. Use different lookup keys depending on the resource type

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"description":{"content":"

The value of the key (an id, sourceId, sku, etc.)

\n","type":"text/plain"},"type":"any","value":"37221","key":"lookupValue"}]}},"response":[{"id":"9d3414df-5d98-4217-999a-5b819380f2bc","name":"Bulk product attribute values by product id - 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"WEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"value\": 15\r\n },\r\n {\r\n \"name\": \"MATERIAAL_FRAME\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Leer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Leather\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"HEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"enum\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"37221","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"610"},{"key":"date","value":"Tue, 08 Mar 2022 13:49:45 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"2889a476-1af6-4d0f-95ee-c3f092d1813d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"message\": \"Attribute value put.\",\n \"success\": true,\n \"id\": 661,\n \"key\": \"WEIGHT\",\n \"value\": 15,\n \"action\": \"put\",\n \"lookupKey\": \"name\"\n },\n {\n \"message\": \"Attribute value put.\",\n \"success\": true,\n \"id\": 671,\n \"key\": \"MATERIAAL_FRAME\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"value\": \"Leer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Leather\"\n }\n ],\n \"action\": \"put\",\n \"lookupKey\": \"name\"\n },\n {\n \"error\": \"Attribute with name [HEIGHT] not found.\",\n \"success\": false,\n \"key\": \"HEIGHT\",\n \"action\": \"put\",\n \"lookupKey\": \"name\"\n },\n {\n \"message\": \"Attribute value deleted (set to default).\",\n \"success\": true,\n \"id\": 668,\n \"key\": \"COLOR\",\n \"action\": \"delete\",\n \"lookupKey\": \"name\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 4\n}"},{"id":"54770497-301b-48b7-926e-636cc4e46ac7","name":"Bulk product attribute values by product id - 400 (schema validation error)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"WEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"value\": []\r\n },\r\n {\r\n \"name\": \"MATERIAAL_FRAME\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Leer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Leather\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"HEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"enum\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"37221","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"636"},{"key":"date","value":"Tue, 08 Mar 2022 13:51:29 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"0414e304-7170-4878-ab25-c744c595cd6a"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/0/type: decimal is not a valid enum value\",\n \"#/0/type: decimal is not a valid enum value\",\n \"#/0/value: expected type: String, found: JSONArray\",\n \"#/0/type: decimal is not a valid enum value\",\n \"#/0/value: expected type: Integer, found: JSONArray\",\n \"#/0/value: expected type: Number, found: JSONArray\",\n \"#/0/type: decimal is not a valid enum value\",\n \"#/0/value: expected type: String, found: JSONArray\",\n \"#/0/type: decimal is not a valid enum value\",\n \"#/0/value: expected type: String, found: JSONArray\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"},{"id":"47c259f4-9680-4c79-b390-f0170ca919a8","name":"Bulk product attribute values by product id - 404","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"WEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"value\": 15\r\n },\r\n {\r\n \"name\": \"MATERIAAL_FRAME\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Leer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Leather\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"HEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"enum\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","type":"text","disabled":true}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"372212","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Tue, 08 Mar 2022 14:23:40 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"1e56da1b-e059-4eee-af23-585e22926db0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10009\",\n \"messages\": [\n \"Parent resource [Product] with id [372212] not found.\"\n ],\n \"status\": 404,\n \"code\": 10009,\n \"type\": \"ParentProductNotFound\"\n }\n}"},{"id":"c1020d7c-9e05-400d-b399-9251316e9ecd","name":"Bulk product attribute values by product source id - 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"WEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"value\": 15\r\n },\r\n {\r\n \"name\": \"MATERIAAL_FRAME\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Leer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Leather\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"HEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"enum\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes?source=RESTAPI","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`"}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"sourceId","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"076548","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"610"},{"key":"date","value":"Tue, 08 Mar 2022 13:49:45 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"2889a476-1af6-4d0f-95ee-c3f092d1813d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"message\": \"Attribute value put.\",\n \"success\": true,\n \"id\": 661,\n \"key\": \"WEIGHT\",\n \"value\": 15,\n \"action\": \"put\",\n \"lookupKey\": \"name\"\n },\n {\n \"message\": \"Attribute value put.\",\n \"success\": true,\n \"id\": 671,\n \"key\": \"MATERIAAL_FRAME\",\n \"value\": [\n {\n \"language\": \"NL\",\n \"value\": \"Leer\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Leather\"\n }\n ],\n \"action\": \"put\",\n \"lookupKey\": \"name\"\n },\n {\n \"error\": \"Attribute with name [HEIGHT] not found.\",\n \"success\": false,\n \"key\": \"HEIGHT\",\n \"action\": \"put\",\n \"lookupKey\": \"name\"\n },\n {\n \"message\": \"Attribute value deleted (set to default).\",\n \"success\": true,\n \"id\": 668,\n \"key\": \"COLOR\",\n \"action\": \"delete\",\n \"lookupKey\": \"name\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 4\n}"},{"id":"fa6cc1cf-8731-4049-9cbd-dc4a0de176de","name":"Bulk product attribute values by product source id - 404","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"WEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"decimal\",\r\n \"value\": 15\r\n },\r\n {\r\n \"name\": \"MATERIAAL_FRAME\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Leer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Leather\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"HEIGHT\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"enum\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes?source=RESTAPI","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`"}],"variable":[{"key":"resourceType","value":"products","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"sourceId","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"076548","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"198"},{"key":"date","value":"Tue, 08 Mar 2022 14:26:10 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"68df5e8c-6053-45d1-9b00-3c9e88bfdd33"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10009\",\n \"messages\": [\n \"Parent resource [Product] with sourceId [076548] not found.\"\n ],\n \"status\": 404,\n \"code\": 10009,\n \"type\": \"ParentProductNotFound\"\n }\n}"},{"id":"125fbe3c-e296-475d-b4b1-889cfce812ec","name":"Bulk user attribute values by user id and attribute name - 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"SHOW_REKENING\",\r\n \"class\": \"user\",\r\n \"type\": \"enum\",\r\n \"value\": \"Y\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/:resourceType/:lookupKey/:lookupValue/attributes","host":["https://api.helice.cloud/api/g/v1"],"path":[":resourceType",":lookupKey",":lookupValue","attributes"],"query":[{"key":"source","value":"RESTAPI","description":"Optional. Used in combination with lookup key `sourceId`","disabled":true}],"variable":[{"key":"resourceType","value":"users","description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"key":"lookupKey","value":"id","description":"Lookup key. Use [different lookup](#lookup-keys) keys depending on the resource type"},{"key":"lookupValue","value":"14719","description":"The value of the key (an id, sourceId, sku, etc.)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"173"},{"key":"date","value":"Mon, 14 Mar 2022 11:47:58 GMT"},{"key":"server","value":"istio-envoy"},{"key":"alt-svc","value":"clear"},{"key":"x-request-id","value":"86561cda-74b1-44a5-bc18-7a0c6b71c7b3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"message\": \"Attribute value put.\",\n \"success\": true,\n \"id\": 48,\n \"key\": \"SHOW_REKENING\",\n \"value\": \"Y\",\n \"action\": \"put\",\n \"lookupKey\": \"name\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 1\n}"}],"_postman_id":"d0bf4d6a-5928-4fd8-b50d-3ac1d227829f"}],"id":"397187f1-f5b7-464a-b51d-f8ddbfd76e8e","description":"

Attributes are resources custom defined fields which can be created manually via the Propeller Backoffice or imported via the REST API. Attributes are a powerful and flexible mechanism which are usually used to define products' specification. Another use case is when Propeller's resource pre defined properties are simply not sufficient. Attribute resource values can be inherited from their parent resource. For example, if a product attribute is set on a category, that attribute will be inherited on all products under that category, unless the attribute is set on the product itself.

Attribute Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller attribute id, auto-generated
name	string	the name of the attribute. Attribute name can contain any alphanumeric uppercase character and `_`.

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
name	User friendly attribute identifier. Name is unique per attribute `class`. Can contain any alphanumeric uppercase character and `_`. Cannot be updated after attribute is created.	string
class	The type of resource for which the attribute will be used. Cannot be updated after attribute is created. Possible values are `product`, `category` , `user`. `user` is used for both users and usergroups resources.	string
isPublic	Boolean value. Indicates whether attribute will be publicly available or only within Propeller backoffice.	boolean Default value is `true`
isSearchable	Boolean value. It is used only for attributes class `product`. Indicates whether attribute values will be indexed and available for searching.	boolean Default value is `false`
isSystem	Boolean value. Special custom usage. System attributes are not visible in the resource Attribute tab in Propeller backoffice.	boolean Default value is `false`
isHidden	Boolean value. Special custom usage. Hidden attributes are not visible in the resource Attribute tab in Propeller backoffice. Default value is `false`.	boolean Default value is `false`
type	Type of the value. Cannot be updated after attribute is created. Possible values are `text`, `list`, `enum`, `enumlist`, `integer`, `decimal`, `date`, `datetime`. `list` is a multi value attribute with comma delimited list of values. `enum` is a single value attribute. The possible values are predefined in a valueset. `enumlist` is a multi-value attribute. The value is a comma delimited list of values predefined in a valueset.	string
typeParam (string)	Used in combination with type `enum` and `enumlist`. The name of the valueset that holds all possible values.	string
descriptions	Attribute description/ label.	array[LocalizedString]
value	Attribute default value/ resource value. Possible values depend on `type`	array[LocalizedString] (`text`, `list`) string (`enum`, `enumlist`) integer decimal date datetime
units	Attribute unit. Ex. use case: If an attribute is a type of measurement like weight or height, the unit will be kg or cm, etc.	array[LocalizedString]
group	Attributes are sometimes related to each other. `group` is used to link them.	string

Attribute Errors

This section describes error codes specific for the Attribute resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
14001	AttributeNotFound	404	Attribute does not exist	Attribute with such lookup key already exists
14002	AttributeMultipleFound	400	Multuple attributes found. Please provide additional filters	Multiple attributes with such lookup key found. Provide additional filters
14003	AttributeExists	400	Attribute already exists	Attribute with such `name` already exists
14004	AttributeInvalidClass	400	No attributes defined for class	Attributes for resources of the provided class are not configured
14005	AttributeInvalidValue	400	Invalid value provided	The attribute value does not correspond with the attribute type

","_postman_id":"397187f1-f5b7-464a-b51d-f8ddbfd76e8e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Rules","item":[{"name":"Rules execute","id":"8aa0802a-c7f4-4ef2-a28c-2fad115f8b54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/rules/:resource/execute?shopId=1","description":"

Executes rules for the selected resource.

Provide for resource of type orders. Otherwise ignored. Defaults to first shop

\n","type":"text/plain"},"key":"shopId","value":"1"}],"variable":[{"description":{"content":"

Type of rules to execute:

orders\nusers\nproducts

\n","type":"text/plain"},"type":"any","value":"products","key":"resource"}]}},"response":[],"_postman_id":"8aa0802a-c7f4-4ef2-a28c-2fad115f8b54"},{"name":"Rules reset","id":"079630ec-6051-4064-8050-3fc58ab7960b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/rules/:resource/reset?shopId=1","description":"

Propeller keeps track on which entities rules have been executed. Once all rules have been executed on an entity it will be internally marked as 'rules applied' and executing the rules execute endpoint again will not trigger the rules for this entity anymore.

There are two ways of 'resetting' the 'rules applied' value:

update the entity (either via the Propeller back office or API)
by using the rules reset endpoint.

The rules reset endpoint resets the 'rules applied' value for all entities.

Provide for resource of type orders. Otherwise ignored. Defaults to first shop

\n","type":"text/plain"},"key":"shopId","value":"1"}],"variable":[{"description":{"content":"

Type of rules to execute:

users\nproducts

\n","type":"text/plain"},"type":"any","value":"orders","key":"resource"}]}},"response":[],"_postman_id":"079630ec-6051-4064-8050-3fc58ab7960b"}],"id":"38e05a2a-32f0-4fa8-a193-cf9c04c8a1ea","description":"

The Propeller rules engine allows for fast and easy data formatting and/or structuring. Based on certain conditions, actions on orders, products or users will be executed.

\n","_postman_id":"38e05a2a-32f0-4fa8-a193-cf9c04c8a1ea","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Links","item":[{"name":"Bulk Links by lookup key","id":"bad92188-6578-452b-bc49-e1767ee479e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"links\": [\r\n {\r\n \"type\": \"account\",\r\n \"subtype\": \"manage\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"customer\",\r\n \"id\": 19815\r\n },\r\n \"to\": {\r\n \"class\": \"company\",\r\n \"id\": 204\r\n }\r\n },\r\n {\r\n \"type\": \"account\",\r\n \"subtype\": \"manage\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"contact\",\r\n \"id\": 14575\r\n },\r\n \"to\": {\r\n \"class\": \"company\",\r\n \"id\": 150\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/links/bulk/:lookupKey","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of links with just a single API call. When using the bulk id endpoint, the link resources are identified by Propeller id. If a link for resources with such id doesn't already exist, it will be created. If it does exist, it will be updated.

When using the bulk sourceId endpoint, the link resources are identified by Propeller sourceId and source.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
type	yes
subtype	yes
isDefault	no Defaults to `false`
isActive	no Defaults to `true`
from	yes
to	yes
priority	no Default to 0

From and to resources lookup keys. id and sourceId are supported.

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"}]}},"response":[{"id":"ecf3efcd-6434-44b1-8724-4fe473ff216f","name":"Bulk Links by id - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"links\": [\r\n {\r\n \"type\": \"account\",\r\n \"subtype\": \"manage\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"customer\",\r\n \"id\": 19815\r\n },\r\n \"to\": {\r\n \"class\": \"company\",\r\n \"id\": 204\r\n }\r\n },\r\n {\r\n \"type\": \"account\",\r\n \"subtype\": \"manage\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"contact\",\r\n \"id\": 14575\r\n },\r\n \"to\": {\r\n \"class\": \"company\",\r\n \"id\": 150\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/links/bulk/:lookupKey","host":["https://api.helice.cloud/api/g/v1"],"path":["links","bulk",":lookupKey"],"variable":[{"key":"lookupKey","value":"id","description":"From and to resources lookup keys. `id` and `sourceId` are supported."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"318"},{"key":"Date","value":"Tue, 27 Sep 2022 13:40:23 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"error\": \"Customer with id [19815] not found\",\n \"to\": {\n \"class\": \"company\",\n \"id\": 204\n },\n \"success\": false,\n \"from\": {\n \"class\": \"customer\",\n \"id\": 19815\n },\n \"lookupKey\": \"id\"\n },\n {\n \"to\": {\n \"class\": \"company\",\n \"id\": 150\n },\n \"success\": true,\n \"id\": 543843,\n \"from\": {\n \"class\": \"contact\",\n \"id\": 14575\n },\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"3d76ad71-de6c-438d-b831-8e03eb81f034","name":"Bulk Links by lookup key - 400 (invalid lookup key)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"links\": [\r\n {\r\n \"type\": \"account\",\r\n \"subtype\": \"manage\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"customer\",\r\n \"id\": 19815\r\n },\r\n \"to\": {\r\n \"class\": \"company\",\r\n \"id\": 204\r\n }\r\n },\r\n {\r\n \"type\": \"account\",\r\n \"subtype\": \"manage\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"contact\",\r\n \"id\": 14575\r\n },\r\n \"to\": {\r\n \"class\": \"company\",\r\n \"id\": 150\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/links/bulk/:lookupKey","host":["https://api.helice.cloud/api/g/v1"],"path":["links","bulk",":lookupKey"],"variable":[{"key":"lookupKey","value":"ids","description":"From and to resources lookup keys. `id` and `sourceId` are supported."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"219"},{"key":"Date","value":"Tue, 27 Sep 2022 13:41:13 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10006\",\n \"messages\": [\n \"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]\"\n ],\n \"status\": 400,\n \"code\": 10006,\n \"type\": \"InvalidLookupKey\"\n }\n}"},{"id":"12961764-4bf1-469c-8d4d-624c9cf4351c","name":"Bulk Links by id - 200 (Product cross/upsell use case)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"links\": [\r\n {\r\n \"type\": \"accessories\",\r\n \"subtype\": \"normal\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"product\",\r\n \"id\": 227293\r\n },\r\n \"to\": {\r\n \"class\": \"product\",\r\n \"id\": 227294\r\n }\r\n },\r\n {\r\n \"type\": \"alternatives\",\r\n \"subtype\": \"normal\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"product\",\r\n \"id\": 227293\r\n },\r\n \"to\": {\r\n \"class\": \"product\",\r\n \"id\": 227292\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/links/bulk/:lookupKey","host":["https://api.helice.cloud/api/g/v1"],"path":["links","bulk",":lookupKey"],"variable":[{"key":"lookupKey","value":"id","description":"From and to resources lookup keys. `id` and `sourceId` are supported."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"291"},{"key":"Date","value":"Fri, 14 Jul 2023 13:12:03 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"to\": {\n \"class\": \"product\",\n \"id\": 227294\n },\n \"success\": true,\n \"id\": 543973,\n \"from\": {\n \"class\": \"product\",\n \"id\": 227293\n },\n \"lookupKey\": \"id\"\n },\n {\n \"to\": {\n \"class\": \"product\",\n \"id\": 227292\n },\n \"success\": true,\n \"id\": 543974,\n \"from\": {\n \"class\": \"product\",\n \"id\": 227293\n },\n \"lookupKey\": \"id\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"7c8f3899-c3f2-40fb-aaf0-3a240d1e692d","name":"Bulk Links by sourceId - 200 (Product cross/upsell use case)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"links\": [\r\n {\r\n \"type\": \"accessories\",\r\n \"subtype\": \"normal\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD7000411\",\r\n \"language\": \"NL\"\r\n },\r\n \"to\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\"\r\n }\r\n },\r\n {\r\n \"type\": \"alternatives\",\r\n \"subtype\": \"normal\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD7000411\",\r\n \"language\": \"NL\"\r\n },\r\n \"to\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004123\",\r\n \"language\": \"NL\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/links/bulk/:lookupKey","host":["https://api.helice.cloud/api/g/v1"],"path":["links","bulk",":lookupKey"],"variable":[{"key":"lookupKey","value":"sourceId","description":"From and to resources lookup keys. `id` and `sourceId` are supported."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"502"},{"key":"Date","value":"Fri, 14 Jul 2023 14:08:51 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"to\": {\n \"class\": \"product\",\n \"source\": \"TECHDATA\",\n \"sourceId\": \"NCABD70004\",\n \"language\": \"NL\"\n },\n \"success\": true,\n \"id\": 543975,\n \"from\": {\n \"class\": \"product\",\n \"source\": \"TECHDATA\",\n \"sourceId\": \"NCABD7000411\",\n \"language\": \"NL\"\n },\n \"lookupKey\": \"sourceId\"\n },\n {\n \"to\": {\n \"class\": \"product\",\n \"source\": \"TECHDATA\",\n \"sourceId\": \"NCABD70004123\",\n \"language\": \"NL\"\n },\n \"success\": true,\n \"id\": 543976,\n \"from\": {\n \"class\": \"product\",\n \"source\": \"TECHDATA\",\n \"sourceId\": \"NCABD7000411\",\n \"language\": \"NL\"\n },\n \"lookupKey\": \"sourceId\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"a5bfb81d-0368-4ee4-bfe9-77418980b27c","name":"Bulk Links by sourceId - 400 (schema validation error)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"links\": [\r\n {\r\n \"type\": \"accessories-dummy\",\r\n \"subtype\": \"normal\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD7000411\",\r\n \"language\": \"NL\"\r\n },\r\n \"to\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004\",\r\n \"language\": \"NL\"\r\n }\r\n },\r\n {\r\n \"type\": \"alternatives\",\r\n \"subtype\": \"normal\",\r\n \"isDefault\": true,\r\n \"isActive\": true,\r\n \"from\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD7000411\",\r\n \"language\": \"NL\"\r\n },\r\n \"to\": {\r\n \"class\": \"product\",\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD70004123\",\r\n \"language\": \"NL\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/links/bulk/:lookupKey","host":["https://api.helice.cloud/api/g/v1"],"path":["links","bulk",":lookupKey"],"variable":[{"key":"lookupKey","value":"sourceId","description":"From and to resources lookup keys. `id` and `sourceId` are supported."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Return-Format","value":"json"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"202"},{"key":"Date","value":"Fri, 14 Jul 2023 14:10:45 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/10007\",\n \"messages\": [\n \"#/links/0/type: accessories-dummy is not a valid enum value\"\n ],\n \"status\": 400,\n \"code\": 10007,\n \"type\": \"SchemaValidationException\"\n }\n}"}],"_postman_id":"bad92188-6578-452b-bc49-e1767ee479e7"},{"name":"Search Links","id":"a738a15e-5a69-47b5-82dc-1e1d77b9ba36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"accessories\",\r\n \"subtype\": \"Extrasale\",\r\n \"priority\": 0,\r\n \"offset\": 100,\r\n \"from\": {\r\n \"class\": \"product\",\r\n \"ids\": [24603]\r\n },\r\n \"to\": {\r\n \"class\": \"product\",\r\n \"ids\": [27401]\r\n },\r\n \"page\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/links/search","description":"

Retrieves a list of links by using the search fields below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
type	string
subtype	string
from	JSON object { \"class\": \"product\", \"ids\": [12345, 65984] }
to	JSON object { \"class\": \"product\", \"ids\": [12345, 65984] }
isActive	boolean
isDefault	boolean
priority	int
offset	int (max: 100, default: 12)
page	int

Results will be paginated. The default number of links per page is 12, but can be up to 100.

Use this endpoint to retrieve link details by link id.

Use this endpoint to update a link by id.

Use this endpoint to delete a link by id.

Propeller supports different types of resources, such as categories, products, usergroups, users, companies, etc. These resources can be linked to one another to cover different use cases, from enriching products with other similar products, accessories, etc. to indicating an account manager user of a company. These relationship types are predefined and are listed below. The Link API can be used to consult, create, update or delete a link between two resources.

Link types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Subtype	From resource	To resource	Use case
accessories	*	*	*	Typically used for products enrichment
accessoryfor	*	*	*	Typically used for products enrichment
related	*	*	*	Typically used for products enrichment
relatedfor	*	*	*	Typically used for products enrichment
alternatives	*	*	*	Typically used for products enrichment
options	*	*	*	Typically used for products enrichment
parts	*	*	*	Typically used for products enrichment
partfor	*	*	*	Typically used for products enrichment
account	manage	user	company	User which is an account manager of a company
account	manage	contact	company	Contact which is an account manager of a company

*any can be used

Link Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller link id, auto-generated

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
type	Link type	string
subtype	Link subtype	string
isDefault	Indicates whether the `to` resource is the default one of the particular type/ subtype for the `from` resource	boolean
isActive	Indicates whether the link is active, same as non existing if not	boolean
from	The resource for which relationships are created	LinkResource
to	The resource to which relationships are created	LinkResource
priority	The order/ priority of the link in relation to other links of the same type, subtype, from and to resource	int

Link Resource

A link resource is a JSON object used for identifying resources that need to be linked. It has two properties: to indicate the class of the resource (product, user, category, etc.) and it's id.

{\n    \"class\": \"product\",\n    \"id\": 56987\n}\n\n

Link Errors

This section describes error codes specific for the Link resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
18001	LinkInvalidClass	400	No links defined for class	The link type/ subtype combination is not valid for the from/ to class
18002	LinkInvalidType	400	Invalid link type/ subtype	Invalid link type or subtype. No such link predefined
18003	LinkNotFound	404	Link not found	Link does not exist

","_postman_id":"6f14a772-8ead-4ff4-817e-075573faad1e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Cluster Config","item":[{"name":"Create Cluster Config","id":"d5c2c98d-24d3-4818-a29f-8c975e2b5f76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"LINEAR_CLUSTER\",\r\n \"settings\": [\r\n {\r\n \"attributeName\": \"PROPELLER_COLOR\",\r\n \"displayType\": \"color\",\r\n \"priority\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clustersconfig/","description":"

Use this endpoint to create a cluster config. If a cluster config is successfully created, the response will include the cluster config id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
name	yes
settings	no

Settings

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
attributeName	yes
displayType	yes
priority	no

Use this endpoint to retrieve cluster config details by lookup key.

Optional. Use settings to retrieve the settings details of the cluster config.

\n","type":"text/plain"},"key":"expands","value":"settings"}],"variable":[{"id":"d50320fb-9fca-4709-b1fc-90d8e044a264","description":{"content":"

Lookup key. Read more about cluster config lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"71eead6d-e2e3-4579-a4fa-81a99782de8c","description":{"content":"

The value of the key (id or name)

\n","type":"text/plain"},"type":"any","value":"11","key":"lookupValue"}]}},"response":[{"id":"1e896a67-559f-4607-8db3-e2c73f0d3589","name":"Get Cluster Config by lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue?expands=settings","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"settings","description":"Optional. Use `settings` to retrieve the settings details of the cluster config."}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"11","description":"The value of the key (id, name)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"184"},{"key":"date","value":"Fri, 27 Oct 2023 11:51:06 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b8925b84-12db-4723-9022-c28943b7f16b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"settings\": [\n {\n \"clusterConfigId\": 11,\n \"displayType\": \"color\",\n \"priority\": \"1\",\n \"id\": 115,\n \"attributeName\": \"PROPELLER_COLOR\"\n }\n ],\n \"name\": \"LINEAR_CLUSTER\",\n \"id\": 11\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"93a27690-466f-488b-87d2-bd1cc492684b","name":"Get Cluster Config by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue?expands=settings","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"settings","description":"Optional. Use `settings` to retrieve the settings details of the cluster config."}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"12","description":"The value of the key (id, name)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"176"},{"key":"date","value":"Fri, 27 Oct 2023 11:51:34 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"0db5a3b1-69a8-489f-b828-1dc50c96cfd5"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/21005\",\n \"messages\": [\n \"Cluster Config with id [12] not found\"\n ],\n \"status\": 404,\n \"code\": 21005,\n \"type\": \"ClusterConfigNotFound\"\n }\n}"}],"_postman_id":"89a2dd85-75a7-4043-9ccc-d2bd711ff52b"},{"name":"Add Setting to Cluster Config","id":"91d0ee15-5df0-4ae2-afdd-a704d27aa12c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"attributeName\": \"PROPELLER_SIZE\",\r\n \"displayType\": \"dropdown\",\r\n \"priority\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings","description":"

Use this endpoint to add additional settings to a cluster config. If a cluster config setting is successfully created, the response will include the id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
attributeName	yes
displayType	yes
priority	no

Lookup key. Read more about cluster config lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"e8c12234-2c03-45c5-ba2d-0e6e039fb946","description":{"content":"

The value of the key (id or name)

\n","type":"text/plain"},"type":"any","value":"11","key":"lookupValue"}]}},"response":[{"id":"882265d3-1760-446d-9ee5-0139fe8829c1","name":"Add Setting to Cluster Config - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"attributeName\": \"PROPELLER_SIZE\",\r\n \"displayType\": \"dropdown\",\r\n \"priority\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue","settings"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"11","description":"The value of the key (id or name)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"169"},{"key":"date","value":"Fri, 27 Oct 2023 11:56:11 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"916787ee-871a-4792-b7fd-2fd909098684"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributeName\": \"PROPELLER_SIZE\",\n \"displayType\": \"dropdown\",\n \"priority\": 2,\n \"clusterConfigId\": 11,\n \"id\": 116\n },\n \"messages\": [\n \"Cluster Config Setting created\"\n ],\n \"total\": 1\n}"},{"id":"3e7a9cfc-87ff-414c-acd5-a3a29195b93f","name":"Add Setting to Cluster Config - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"attributeName\": \"PROPELLER_SIZE111\",\r\n \"displayType\": \"dropdown\",\r\n \"priority\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue","settings"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"11","description":"The value of the key (id or name)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"214"},{"key":"date","value":"Fri, 27 Oct 2023 11:56:54 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"74e2a5e4-55fa-4b46-abeb-aeaab16d5576"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/14001\",\n \"messages\": [\n \"Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found.\"\n ],\n \"status\": 404,\n \"code\": 14001,\n \"type\": \"AttributeNotFound\"\n }\n}"}],"_postman_id":"91d0ee15-5df0-4ae2-afdd-a704d27aa12c"},{"name":"Update Cluster Config Setting","id":"7a495a14-1271-47a3-b8fa-20c64d90f0ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"displayType\": \"radio\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings/:settingId","description":"

Use this endpoint to update a setting on the cluster config by cluster config lookup key and setting id. Attrubute name can't be updated.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
displayType	no
priority	no

Lookup key. Read more about cluster config lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"826fbb59-1b22-4941-bec2-8187e9c4024c","description":{"content":"

The value of the key (id or name)

\n","type":"text/plain"},"type":"any","value":"11","key":"lookupValue"},{"id":"975f4e4c-4830-410c-9383-e56ea3b9aac3","description":{"content":"

The id of cluster config setting

\n","type":"text/plain"},"type":"any","value":"116","key":"settingId"}]}},"response":[{"id":"5443e435-2b59-45d5-9853-8c0858ff3a0a","name":"Update Cluster Config Setting - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"displayType\": \"radio\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings/:settingId","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue","settings",":settingId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"11","description":"The value of the key (id or name)"},{"key":"settingId","value":"116","description":"The id of cluster config setting"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"99"},{"key":"date","value":"Fri, 27 Oct 2023 11:59:41 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a73fa162-0f96-41c0-bb43-2bb3eb744100"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"displayType\": \"radio\",\n \"id\": 116\n },\n \"messages\": [\n \"Cluster Config Setting updated\"\n ],\n \"total\": 1\n}"},{"id":"15d21622-4fb8-464d-a444-e8086a412031","name":"Update Cluster Config Setting - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"displayType\": \"radio\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings/:settingId","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue","settings",":settingId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"11","description":"The value of the key (id or name)"},{"key":"settingId","value":"117","description":"The id of cluster config setting"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"192"},{"key":"date","value":"Fri, 27 Oct 2023 12:00:06 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"0aa2856c-2fd5-4a52-8444-c532e5ba8ecf"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/21007\",\n \"messages\": [\n \"Cluster config setting with id [117] not found\"\n ],\n \"status\": 404,\n \"code\": 21007,\n \"type\": \"ClusterConfigSettingNotFound\"\n }\n}"}],"_postman_id":"7a495a14-1271-47a3-b8fa-20c64d90f0ae"},{"name":"Remove Setting from Cluster Config","id":"5c1c4ad9-1429-4940-82b9-a2569e93d603","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings/:settingId","description":"

Use this endpoint to delete a setting on the cluster config by cluster config lookup key and setting id.

Lookup key. Read more about cluster config lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"4b1b3678-37b4-414f-bfba-bb094d1a5b28","description":{"content":"

The value of the key (id or name)

\n","type":"text/plain"},"type":"any","value":"11","key":"lookupValue"},{"id":"679fd79f-7e20-4a64-990c-a1a509cab7b0","description":{"content":"

The id of cluster config setting

\n","type":"text/plain"},"type":"any","value":"116","key":"settingId"}]}},"response":[{"id":"f57f17ab-ee09-46f2-aacd-a3c2ba9644e5","name":"Remove Setting from Cluster Config - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings/:settingId","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue","settings",":settingId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"11","description":"The value of the key (id or name)"},{"key":"settingId","value":"116","description":"The id of cluster config setting"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"59"},{"key":"date","value":"Fri, 27 Oct 2023 12:01:28 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"ef96dc84-ebbd-4a4d-92d6-a8bedd2d7652"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Cluster Config setting deleted\"\n ]\n}"},{"id":"316d737d-003e-4fc9-8f70-4cf2051fd030","name":"Remove Setting from Cluster Config - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue/settings/:settingId","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue","settings",":settingId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"11","description":"The value of the key (id or name)"},{"key":"settingId","value":"117","description":"The id of cluster config setting"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"192"},{"key":"date","value":"Fri, 27 Oct 2023 12:01:48 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"131ed70f-1bc1-45a7-88c8-9385c2d484a1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/21007\",\n \"messages\": [\n \"Cluster config setting with id [117] not found\"\n ],\n \"status\": 404,\n \"code\": 21007,\n \"type\": \"ClusterConfigSettingNotFound\"\n }\n}"}],"_postman_id":"5c1c4ad9-1429-4940-82b9-a2569e93d603"},{"name":"Remove Cluster Config","id":"975c06c3-d9c8-487a-b63a-9bdca3820b9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue","description":"

Use this endpoint to delete cluster config by lookup key.

Lookup key. Read more about cluster config lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"ecd7fa2d-3dee-4039-8901-faa77ba8219e","description":{"content":"

The value of the key (id or name)

\n","type":"text/plain"},"type":"any","value":"8","key":"lookupValue"}]}},"response":[{"id":"3b4c1a66-c2b7-4b6e-a062-36e014c36932","name":"Remove Cluster Config - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"8","description":"The value of the key (id or name)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"51"},{"key":"date","value":"Fri, 27 Oct 2023 12:02:58 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"57071cd3-b8d9-4112-a08d-3b16e1d28052"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Cluster Config deleted\"\n ]\n}"},{"id":"43380ccc-6279-48b1-9e7d-371df256c1fe","name":"Remove Cluster Config - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clustersconfig/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["clustersconfig",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"key":"lookupValue","value":"7","description":"The value of the key (id or name)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"175"},{"key":"date","value":"Fri, 27 Oct 2023 12:04:55 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"308b6bfb-2a06-4fc7-903d-b7dec33b6de2"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/21005\",\n \"messages\": [\n \"Cluster Config with id [7] not found\"\n ],\n \"status\": 404,\n \"code\": 21005,\n \"type\": \"ClusterConfigNotFound\"\n }\n}"}],"_postman_id":"975c06c3-d9c8-487a-b63a-9bdca3820b9a"}],"id":"dc7f36f4-9eea-49a3-8b55-6b6582314bfc","description":"

Cluster configs are used as rules on how to organize and group your products into clusters within your e-commerce platform. There can be normal clusters for example where there is no need to define attribute, but there can be linear or complex clusters, where you need to define one or two attributes that will be used to group the products.

Cluster Config Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller cluster config id, auto-generated
name	string	Cluster config name

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
name	Cluster config name	string (only alphanumeric characters combined with underscore)
settings	Cluster config settings	array

Settings

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
attributeName	Setting attribute name	string
displayType	Setting display type	enum - dropdown - radio - image - color
priority	Setting priority	integer

Cluster Config Errors

This section describes error codes specific for the ClusterConfig resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
21004	ClusterConfigExists	400	Cluster Config already exists	Cluster config with such name already exists
21005	ClusterConfigNotFound	404	Cluster Config does not exist	Cluster config with such lookup key not found
21006	ClusterConfigSettingExists	400	Cluster Config Setting already exists	Cluster config setting with such attribute name already exists
21007	ClusterConfigSettingNotFound	404	Cluster Config Setting does not exist	Cluster config setting with such lookup key not found

","_postman_id":"dc7f36f4-9eea-49a3-8b55-6b6582314bfc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Clusters","item":[{"name":"Cluster Options","item":[{"name":"Create Cluster Option","id":"8064dc7f-d691-4fab-8e11-2c9afc3092e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options","description":"

Use this endpoint to create a single cluster option. If a cluster option is successfully created, the response will include the option id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
sourceId	no
source	only when `sourceId` is provided
isRequired	no

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"2c37ac5e-f6d3-46ab-b9eb-25b538062b44","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"}]}},"response":[{"id":"76a10c29-f6b4-416d-9cef-11c1dbc6e81b","name":"Create Cluster Option - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"287"},{"key":"date","value":"Tue, 31 Oct 2023 13:34:01 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"76e88d05-5fb9-4fe6-90d1-6e2ec0c21f14"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Mouse\"\n }\n ],\n \"language\": \"NL\",\n \"sourceId\": \"K72334000\",\n \"source\": \"RESTAPI\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Mouse\"\n }\n ],\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Mouse\"\n }\n ],\n \"isRequired\": \"N\",\n \"id\": 214\n },\n \"messages\": [\n \"Cluster Option created\"\n ],\n \"total\": 1\n}"},{"id":"058ff6fa-0bcb-414c-bd32-99f04d1c70d8","name":"Create Cluster Option - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"215","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"177"},{"key":"date","value":"Tue, 31 Oct 2023 13:35:44 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"326e0985-904b-4193-b3ba-a9ecf6e29ec1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent Cluster with id [215] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentClusterNotFound\"\n }\n}"}],"_postman_id":"8064dc7f-d691-4fab-8e11-2c9afc3092e3"},{"name":"Get Option by Cluster lookup key and Option Id","id":"ce300824-1a1e-43b8-8f5c-49d97e22bffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId?expands=translation,sources,defaultProduct","description":"

Use this endpoint to get details of single cluster option by cluster lookup key and option id.

Lookup key. Read more about category lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"766e588b-c8fa-4bd6-ac99-0dbaaf144b33","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"},{"id":"a9d1d8dd-2217-4770-909a-c985f839e757","description":{"content":"

The value of option id

\n","type":"text/plain"},"type":"any","value":"214","key":"optionId"}]}},"response":[{"id":"0c5b3a19-5175-4e99-b861-1c16571aef76","name":"Get Option by Cluster lookup key and Option Id - 200","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId?expands=translation,sources,defaultProduct","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options",":optionId"],"query":[{"key":"expands","value":"translation,sources,defaultProduct"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"},{"key":"optionId","value":"214","description":"The value of option id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"301"},{"key":"date","value":"Tue, 31 Oct 2023 13:38:15 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b5442c50-e266-4d74-8d8e-cb6740b865f9"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"K72334\"\n }\n ],\n \"defaultProduct\": \"\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n }\n ],\n \"isRequired\": false,\n \"id\": 214,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n }\n ]\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"0007c068-1c02-499f-9b2d-ea95d777a98c","name":"Get Option by Cluster lookup key and Option Id - 404","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId?expands=translation,sources,defaultProduct","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options",":optionId"],"query":[{"key":"expands","value":"translation,sources,defaultProduct"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"},{"key":"optionId","value":"215","description":"The value of option id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"207"},{"key":"date","value":"Tue, 31 Oct 2023 13:38:57 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"10b7cdcc-c009-43fe-9c84-c18123fd5f68"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20010\",\n \"messages\": [\n \"Cluster Option with id [215] not found for the cluster with id [213]\"\n ],\n \"status\": 404,\n \"code\": 20010,\n \"type\": \"ClusterOptionNotFound\"\n }\n}"}],"_postman_id":"ce300824-1a1e-43b8-8f5c-49d97e22bffe"},{"name":"Update Option by Cluster lookup key and Option Id","id":"9fa5fb1d-686f-4531-99e4-179f1700e1c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId","description":"

Use this endpoint to update single cluster option by cluster lookup key and option id.

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"315acb10-c1ea-4c81-9480-de89a907c493","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"},{"id":"160d130c-61ff-4e8b-a10a-f4c227117abd","description":{"content":"

The value of option id

\n","type":"text/plain"},"type":"any","value":"214","key":"optionId"}]}},"response":[{"id":"b7978a14-2bf7-4a8d-bf01-fbc8245c3676","name":"Update Option by Cluster lookup key and Option Id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options",":optionId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"},{"key":"optionId","value":"214","description":"The value of option id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"276"},{"key":"date","value":"Tue, 31 Oct 2023 13:41:26 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"3fef8739-98a1-494e-9ab0-4b426d518c82"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Mouse\"\n }\n ],\n \"sourceId\": \"K72334000\",\n \"source\": \"RESTAPI\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Mouse\"\n }\n ],\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Mouse\"\n }\n ],\n \"isRequired\": \"N\",\n \"id\": 214\n },\n \"messages\": [\n \"Cluster Option updated\"\n ],\n \"total\": 1\n}"},{"id":"a1367bd0-4daf-4c9c-8e59-d1fb30a747c2","name":"Update Option by Cluster lookup key and Option Id - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options",":optionId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"},{"key":"optionId","value":"216","description":"The value of option id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"207"},{"key":"date","value":"Tue, 31 Oct 2023 13:41:49 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"f10955ac-b7aa-4dda-a09e-ec30174ef4da"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20010\",\n \"messages\": [\n \"Cluster Option with id [216] not found for the cluster with id [213]\"\n ],\n \"status\": 404,\n \"code\": 20010,\n \"type\": \"ClusterOptionNotFound\"\n }\n}"}],"_postman_id":"9fa5fb1d-686f-4531-99e4-179f1700e1c0"},{"name":"Delete Option by Cluster lookup key and Option Id","id":"6daeaa08-0c8b-4821-8109-1ead1323e160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId","description":"

Use this endpoint to delete single cluster option by cluster lookup key and option id.

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"940c9b8b-530e-4aaf-b3b1-3dd6f4f85546","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"},{"id":"c9970eec-1d22-442a-831d-07a17da4833a","description":{"content":"

The value of option id

\n","type":"text/plain"},"type":"any","value":"215","key":"optionId"}]}},"response":[{"id":"cea78799-09b6-4aad-a426-1ab339629f9a","name":"Delete Option by Cluster lookup key and Option Id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options",":optionId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"},{"key":"optionId","value":"215","description":"The value of option id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"51"},{"key":"date","value":"Tue, 31 Oct 2023 13:43:40 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"f227705b-07ef-4c26-95f6-501459df0c3b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Cluster Option deleted\"\n ]\n}"},{"id":"e232791a-822f-4a91-8afc-4e298930385c","name":"Delete Option by Cluster lookup key and Option Id - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/:optionId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options",":optionId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"},{"key":"optionId","value":"216","description":"The value of option id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"207"},{"key":"date","value":"Tue, 31 Oct 2023 13:43:56 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"03a4766d-9840-4e35-9f96-8ec2b675968b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20010\",\n \"messages\": [\n \"Cluster Option with id [216] not found for the cluster with id [213]\"\n ],\n \"status\": 404,\n \"code\": 20010,\n \"type\": \"ClusterOptionNotFound\"\n }\n}"}],"_postman_id":"6daeaa08-0c8b-4821-8109-1ead1323e160"},{"name":"Bulk Cluster Options by lookupKey","id":"129fd1aa-3b41-400b-a763-73a9e0361fcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"options\": [\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n },\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"KM636000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n },\r\n {\r\n \"operation\": \"skipMoveOnUpdate\",\r\n \"fields\": []\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/bulk","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk id endpoint, the options are identified by Propeller option id. If an option with such id doesn't already exist, it will be created. If it does exist, the option will be updated.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
sourceId	no
source	only when `sourceId` is provided
isRequired	no

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing option that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing option in the parent cluster provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for an option that are not provided in the payload	empty array
skipCreate	Do not create new options, only update existing	empty array

What are directives?

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"sourceId","key":"lookupKey"},{"id":"5e6353d1-56d4-412e-8cf1-7731168912dd","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"COFYR88","key":"lookupValue"}]}},"response":[{"id":"755440f2-bbd2-4608-ad64-029263ba2f97","name":"Bulk Cluster Options by lookupKey - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"options\": [\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n },\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"KM636000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n },\r\n {\r\n \"operation\": \"skipMoveOnUpdate\",\r\n \"fields\": []\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options","bulk"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"COFYR88","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"214"},{"key":"date","value":"Tue, 31 Oct 2023 13:51:53 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a508dfec-5778-407d-93b2-3fb7b7c6ccd8"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": \"K72334000\",\n \"id\": 214,\n \"action\": \"update\",\n \"lookupKey\": \"sourceId\"\n },\n {\n \"success\": true,\n \"key\": \"KM636000\",\n \"id\": 216,\n \"action\": \"create\",\n \"lookupKey\": \"sourceId\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"b88f67c2-7ee1-4943-9cdf-ba261b77793b","name":"Bulk Cluster Options by lookupKey - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"options\": [\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"K72334000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Muis\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Mouse\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n },\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"KM636000\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Toetsenbord\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Keyboard\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n },\r\n {\r\n \"operation\": \"skipMoveOnUpdate\",\r\n \"fields\": []\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options","bulk"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"COFYR8800","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"189"},{"key":"date","value":"Tue, 31 Oct 2023 13:52:18 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b332a11c-c599-499e-a1d5-cee87c72d8dc"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent Cluster with sourceId [COFYR8800] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentClusterNotFound\"\n }\n}"}],"_postman_id":"129fd1aa-3b41-400b-a763-73a9e0361fcf"},{"name":"Create Option Product","id":"a315c544-7432-4117-b885-98203132ef36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\r\n }\r\n ],\r\n \"sku\": \"K72334\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\r\n }\r\n ],\r\n \"shortName\": \"Dell draadloze lasermuis via nano USB ontvanger\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"K72334\",\r\n \"oemCode\": \"K72334\",\r\n \"taxCode\": \"H\",\r\n \"price\": 22.3,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"DELL\",\r\n \"costPrice\": 19.05,\r\n \"suggestedPrice\": 22.3,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"option product\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"K72334\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products","description":"

\n
The same endpoints for option products are used as the cluster products, with a difference that option id is used in lookupValue variable instead if cluster id
\n

Use this endpoint to create a single product to the option. If a option product is successfully created, the response will include the productid.

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"ba11e2a2-c35c-4911-9c53-278a0dc0a631","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"214","key":"lookupValue"}]}},"response":[{"id":"556a68e7-a00f-4fbf-8abe-fd19810eb2e8","name":"Create Option Product - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\r\n }\r\n ],\r\n \"sku\": \"K72334\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\r\n }\r\n ],\r\n \"shortName\": \"Dell draadloze lasermuis via nano USB ontvanger\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"K72334\",\r\n \"oemCode\": \"K72334\",\r\n \"taxCode\": \"H\",\r\n \"price\": 22.3,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"DELL\",\r\n \"costPrice\": 19.05,\r\n \"suggestedPrice\": 22.3,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"option product\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"K72334\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"214","description":"The value of the key (id or sourceId)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"802"},{"key":"date","value":"Tue, 31 Oct 2023 13:58:38 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"c0d7b5a9-6b55-4935-a9d0-ce09e908cdb3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"language\": \"NL\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\n }\n ],\n \"sku\": \"K72334\",\n \"status\": \"A\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\n }\n ],\n \"shortName\": \"Dell draadloze lasermuis via nano USB ontvanger\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Dell draadloze lasermuis via nano USB ontvanger\"\n }\n ],\n \"supplier\": \"RESTAPI\",\n \"supplierCode\": \"K72334\",\n \"oemCode\": \"K72334\",\n \"taxCode\": \"H\",\n \"price\": 22.3,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"manufacturer\": \"DELL\",\n \"costPrice\": 19.05,\n \"suggestedPrice\": 22.3,\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"option product\"\n }\n ],\n \"source\": \"RESTAPI\",\n \"sourceId\": \"K72334\",\n \"id\": 707972\n },\n \"messages\": [\n \"Cluster Product created\"\n ],\n \"total\": 1\n}"}],"_postman_id":"a315c544-7432-4117-b885-98203132ef36"}],"id":"8c57fd0a-e781-4ef2-ae33-df950d341c2d","description":"

Cluster Options are available sellable options of the parent Cluster. Cluster Options can also contain Products.

Cluster Option Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller option id, auto-generated

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
names	Option name	array[LocalizedString]
language	Option default language	ISO 639-1
descriptions	Option description	array[LocalizedString]
shortDescriptions	Option short descriptions	array[LocalizedString]
isRequired	Option is required or not	boolean
sourceId	External system unique id	string
source	External system	string

Cluster Option Errors

This section describes error codes specific for the ClusterOption resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
20009	ClusterOptionExists	400	Cluster Option already exists	Cluster Option with such lookup key already exists
20010	ClusterOptionNotFound	404	Cluster Option does not exist	Cluster Option with such lookup key not found
20011	ClusterOptionNotAllowed	405	Cluster Option is not allowed	No permission for the Cluster Option

","_postman_id":"8c57fd0a-e781-4ef2-ae33-df950d341c2d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Cluster Products","item":[{"name":"Create Cluster Product","id":"e7a65413-1156-4dba-9a72-1758f7919bd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra blauw\"\r\n }\r\n ],\r\n \"sku\": \"151203\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra blauw\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151203\",\r\n \"oemCode\": \"151203\",\r\n \"eanCode\": \"4004675044075\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"blawn\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151203\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products","description":"

Use this endpoint to create a single product to the cluster. If a cluster product is successfully created, the response will include the productid.

Fields

Name	Required
names	no
language	yes
sku	no (recommended)
unit	no Default is `1`
status	no Default is `A`
price	no Default is `0.00`
costPrice	no Default is `0.00`
suggestedPrice	no Default is `0.00`
priceDisplay	no Default is `default`
descriptions	no
shortName	no
shortDescriptions	no
taxCode	no Default is `H`
supplier	no (recommended)
supplierCode	no (recommended)
manufacturer	no
oemCode	no
eanCode	no
minimumQuantity	no Default is `1`
package	no
packageDescriptions	no
notes	no
sourceId	no
source	only when `sourceId` is provided

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"42767f6c-039c-4c52-953a-588a5c753c04","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"210","key":"lookupValue"}]}},"response":[{"id":"bc865142-52b6-4e09-bbed-e1ec26bccb1c","name":"Create Cluster Product - 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra blauw\"\r\n }\r\n ],\r\n \"sku\": \"151203\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra blauw\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151203\",\r\n \"oemCode\": \"151203\",\r\n \"eanCode\": \"4004675044075\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"blawn\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151203\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products"],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"210"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"973"},{"key":"date","value":"Tue, 31 Oct 2023 11:22:32 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a7b7f777-e7ad-4932-9a3b-d48a76cdd07b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"language\": \"NL\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra blauw\"\n }\n ],\n \"sku\": \"151203\",\n \"status\": \"A\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\n }\n ],\n \"shortName\": \"Balpen Slider XB extra blauw\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\n }\n ],\n \"supplier\": \"RESTAPI\",\n \"supplierCode\": \"151203\",\n \"oemCode\": \"151203\",\n \"eanCode\": \"4004675044075\",\n \"taxCode\": \"H\",\n \"price\": 1.49,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"manufacturer\": \"SCHNEIDER\",\n \"costPrice\": 1.05,\n \"suggestedPrice\": 1.49,\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"blawn\"\n }\n ],\n \"source\": \"RESTAPI\",\n \"sourceId\": \"151203\",\n \"id\": 707966\n },\n \"messages\": [\n \"Cluster Product created\"\n ],\n \"total\": 1\n}"},{"id":"ce926739-f5c9-471b-9940-8e97f355369d","name":"Create Cluster Product - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra blauw\"\r\n }\r\n ],\r\n \"sku\": \"151203\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra blauw\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151203\",\r\n \"oemCode\": \"151203\",\r\n \"eanCode\": \"4004675044075\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"blawn\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151203\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products"],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"213"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"177"},{"key":"date","value":"Tue, 31 Oct 2023 11:22:54 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"6d9bf531-516c-4bec-9305-e49b5ab1b9d4"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent Cluster with id [213] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentClusterNotFound\"\n }\n}"}],"_postman_id":"e7a65413-1156-4dba-9a72-1758f7919bd3"},{"name":"Get Product by Cluster lookup key and Product Id","id":"84b414bf-9903-4095-8de9-205fbda6cb90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId?expands=translation,sources,surcharges,costprices","description":"

Use this endpoint to retrieve single cluster product details by cluster lookup key and product id.

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"38d03871-c5b6-4ea2-b044-3e6c3a540d74","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"210","key":"lookupValue"},{"id":"a86e0627-86fb-4ad6-8e0f-d275f9615fa1","description":{"content":"

The value of product id

\n","type":"text/plain"},"type":"any","value":"707966","key":"productId"}]}},"response":[{"id":"060c8835-9c21-43f2-a8cb-1ce33e157fda","name":"Get Product by Cluster lookup key and Product Id - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId?expands=translation,sources,surcharges,costprices","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products",":productId"],"query":[{"key":"expands","value":"translation,sources,surcharges,costprices"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"},{"key":"productId","value":"707966","description":"The value of product id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1057"},{"key":"date","value":"Tue, 31 Oct 2023 11:30:26 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"616cce76-17e9-4f12-a31e-6fc6b6815ca1"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"surcharges\": [],\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"151203\"\n }\n ],\n \"eanCode\": \"4004675044075\",\n \"price\": 1.49,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"

blawn

\\r\\n\"\n }\n ],\n \"oemCode\": \"151203\",\n \"manufacturer\": \"Schneider\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra blauw\"\n }\n ],\n \"shortName\": \"Balpen Slider XB extra blauw\",\n \"sku\": \"151203\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 21,\n \"costprices\": [],\n \"supplierCode\": \"151203\",\n \"status\": \"A\",\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"id\": 707966,\n \"unit\": 1,\n \"costPrice\": 1.05,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"suggestedPrice\": 1.49,\n \"supplier\": \"RESTAPI\"\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"158f26eb-0e82-446c-8646-0ad801fbdf72","name":"Get Product by Cluster lookup key and Product Id - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId?expands=translation,sources,surcharges,costprices","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products",":productId"],"query":[{"key":"expands","value":"translation,sources,surcharges,costprices"}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"},{"key":"productId","value":"707968","description":"The value of product id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"212"},{"key":"date","value":"Tue, 31 Oct 2023 11:30:51 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"4a74b63f-ec87-46ca-8a59-a320886f7457"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20013\",\n \"messages\": [\n \"Cluster Product with id [707968] not found for the cluster with id [210]\"\n ],\n \"status\": 404,\n \"code\": 20013,\n \"type\": \"ClusterProductNotFound\"\n }\n}"}],"_postman_id":"84b414bf-9903-4095-8de9-205fbda6cb90"},{"name":"Update Product by Cluster lookup key and Product Id","id":"f825d1b6-d050-4d66-bd0a-63b0469384e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra blauw\"\r\n }\r\n ],\r\n \"sku\": \"151203\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra blauw\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151203\",\r\n \"oemCode\": \"151203\",\r\n \"eanCode\": \"4004675044075\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 0.99,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"blawn\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151203\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId","description":"

Use this endpoint to update single cluster product details by cluster lookup key and product id.

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"0943bf4d-ad45-432e-9e52-10e9255cbd25","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"210","key":"lookupValue"},{"id":"3b11c50d-9001-4e3b-b80c-2e620e0de2c0","description":{"content":"

The value of product id

\n","type":"text/plain"},"type":"any","value":"707966","key":"productId"}]}},"response":[{"id":"329071fd-237d-41f1-942d-50065d342127","name":"Update Product by Cluster lookup key and Product Id - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra blauw\"\r\n }\r\n ],\r\n \"sku\": \"151203\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra blauw\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151203\",\r\n \"oemCode\": \"151203\",\r\n \"eanCode\": \"4004675044075\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 0.99,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"blawn\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151203\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products",":productId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"},{"key":"productId","value":"707966","description":"The value of product id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"959"},{"key":"date","value":"Tue, 31 Oct 2023 11:32:47 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"a3453129-9e07-4719-bf59-54d0f736fc0d"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra blauw\"\n }\n ],\n \"sku\": \"151203\",\n \"status\": \"A\",\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\n }\n ],\n \"shortName\": \"Balpen Slider XB extra blauw\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\n }\n ],\n \"supplier\": \"RESTAPI\",\n \"supplierCode\": \"151203\",\n \"oemCode\": \"151203\",\n \"eanCode\": \"4004675044075\",\n \"taxCode\": \"H\",\n \"price\": 1.49,\n \"unit\": 1,\n \"minimumQuantity\": 1,\n \"manufacturer\": \"SCHNEIDER\",\n \"costPrice\": 0.99,\n \"suggestedPrice\": 1.49,\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"blawn\"\n }\n ],\n \"source\": \"RESTAPI\",\n \"sourceId\": \"151203\",\n \"id\": 707966\n },\n \"messages\": [\n \"Cluster Product updated\"\n ],\n \"total\": 1\n}"},{"id":"d530af93-4a4a-4051-9748-7b4b1cf59e12","name":"Update Product by Cluster lookup key and Product Id - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra blauw\"\r\n }\r\n ],\r\n \"sku\": \"151203\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra blauw\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151203\",\r\n \"oemCode\": \"151203\",\r\n \"eanCode\": \"4004675044075\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 0.99,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"blawn\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151203\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products",":productId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"},{"key":"productId","value":"707968","description":"The value of product id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"212"},{"key":"date","value":"Tue, 31 Oct 2023 11:33:10 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"fb7cb47a-19b8-4ddd-9610-208d4e363be3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20013\",\n \"messages\": [\n \"Cluster Product with id [707968] not found for the cluster with id [210]\"\n ],\n \"status\": 404,\n \"code\": 20013,\n \"type\": \"ClusterProductNotFound\"\n }\n}"}],"_postman_id":"f825d1b6-d050-4d66-bd0a-63b0469384e5"},{"name":"Delete Product by Cluster lookup key and Product Id","id":"fa9794c3-c4eb-4e5e-8c52-7a60bdaea914","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId","description":"

Use this endpoint to delete single cluster product details by cluster lookup key and product id.

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"5874f243-74c8-47d4-98d8-45fc02c25c86","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"210","key":"lookupValue"},{"id":"8b633047-07e0-4b7d-b13b-b46c8a43e494","description":{"content":"

The value of product id

\n","type":"text/plain"},"type":"any","value":"707968","key":"productId"}]}},"response":[{"id":"b9da40cb-9565-4ed7-921f-3063116ad50d","name":"Delete Product by Cluster lookup key and Product Id - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products",":productId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"},{"key":"productId","value":"707968","description":"The value of product id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"52"},{"key":"date","value":"Tue, 31 Oct 2023 11:34:41 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"659e03d9-cc94-4a95-8bdd-acc5d9ca502b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Cluster Product deleted\"\n ]\n}"},{"id":"1ac7ebb5-fff7-45ca-acc2-59e1c658d380","name":"Delete Product by Cluster lookup key and Product Id - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/:productId","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products",":productId"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"},{"key":"productId","value":"707969","description":"The value of product id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"212"},{"key":"date","value":"Tue, 31 Oct 2023 11:34:58 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"7f95d95f-dd02-40b3-9fc1-9df503518608"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20013\",\n \"messages\": [\n \"Cluster Product with id [707969] not found for the cluster with id [210]\"\n ],\n \"status\": 404,\n \"code\": 20013,\n \"type\": \"ClusterProductNotFound\"\n }\n}"}],"_postman_id":"fa9794c3-c4eb-4e5e-8c52-7a60bdaea914"},{"name":"Bulk Cluster Products by sourceId","id":"ecb305ea-d622-4fa3-b756-284b89a255b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra zwart\"\r\n }\r\n ],\r\n \"sku\": \"151201\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra zwart\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151201\",\r\n \"oemCode\": \"151201\",\r\n \"eanCode\": \"4004675044006\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"zwart\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151201\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLER_COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"zwart\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra groen\"\r\n }\r\n ],\r\n \"sku\": \"151204\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra groen\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151204\",\r\n \"oemCode\": \"151204\",\r\n \"eanCode\": \"4004675054708\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"groen\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151204\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLER_COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"groen\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/bulk","description":"

The bulk endpoints offer an efficient way of importing/updating large amounts of cluster products with just a single API call. The same lookup key is used for the products as for the cluster. When using the bulk id endpoint, the products are identified by Propeller product id. If a product with such id doesn't already exist, it will be created. If it does exist, the product will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
products (array of product objects)	yes
sourceId	yes
source	yes
language	yes
names	no
sku	no (recommended)
unit	no Default is `1`
status	no Default is `A`
price	no Default is `0.00`
priceDisplay	no Default is `default`
descriptions	no
shortDescriptions	no
taxCode	no Default is `H`
supplier	no (recommended)
supplierCode	no (recommended)
oemCode	no
eanCode	no
minimumQuantity	no Default is `1`
packageDescriptions	no
notes	no
attributes Read more about attributes	no

For more details on attributes field, read this.

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing product that are not empty	array of field names e.g. names, descriptions, packageDescriptions etc.
skipMoveOnUpdate	On update, skip moving an existing product in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a product that are not provided in the payload	empty array

What are directives?

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"sourceId","key":"lookupKey"},{"id":"3e56c0ca-827e-4829-a6ad-3ec7786036e4","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"15120300","key":"lookupValue"}]}},"response":[{"id":"39799c99-4804-4ed4-842e-283f42707943","name":"Bulk Cluster Products by sourceId - 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra zwart\"\r\n }\r\n ],\r\n \"sku\": \"151201\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra zwart\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151201\",\r\n \"oemCode\": \"151201\",\r\n \"eanCode\": \"4004675044006\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"zwart\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151201\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLER_COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"zwart\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra groen\"\r\n }\r\n ],\r\n \"sku\": \"151204\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra groen\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151204\",\r\n \"oemCode\": \"151204\",\r\n \"eanCode\": \"4004675054708\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"groen\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151204\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLER_COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"groen\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products","bulk"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"15120300","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"215"},{"key":"date","value":"Tue, 31 Oct 2023 11:55:47 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e234dcc7-892c-40cd-a801-ca6645469424"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"success\": true,\n \"key\": \"151201\",\n \"id\": 707969,\n \"action\": \"create\",\n \"lookupKey\": \"sourceId\"\n },\n {\n \"success\": true,\n \"key\": \"151204\",\n \"id\": 707970,\n \"action\": \"create\",\n \"lookupKey\": \"sourceId\"\n }\n ],\n \"messages\": [\n \"Completed\"\n ],\n \"total\": 2\n}"},{"id":"0865e1a0-4403-4a6c-8ef1-e69fbe90bcff","name":"Bulk Cluster Products by sourceId - 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra zwart\"\r\n }\r\n ],\r\n \"sku\": \"151201\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra zwart\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151201\",\r\n \"oemCode\": \"151201\",\r\n \"eanCode\": \"4004675044006\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"zwart\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151201\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLER_COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"zwart\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra groen\"\r\n }\r\n ],\r\n \"sku\": \"151204\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"shortName\": \"Balpen Slider XB extra groen\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ],\r\n \"supplier\": \"RESTAPI\",\r\n \"supplierCode\": \"151204\",\r\n \"oemCode\": \"151204\",\r\n \"eanCode\": \"4004675054708\",\r\n \"taxCode\": \"H\",\r\n \"price\": 1.49,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"SCHNEIDER\",\r\n \"costPrice\": 1.05,\r\n \"suggestedPrice\": 1.49,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"groen\"\r\n }\r\n ],\r\n \"source\": \"RESTAPI\",\r\n \"sourceId\": \"151204\",\r\n \"attributes\": [\r\n {\r\n \"name\": \"PROPELLER_COLOR\",\r\n \"class\": \"product\",\r\n \"type\": \"text\",\r\n \"value\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"groen\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products/bulk","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products","bulk"],"variable":[{"key":"lookupKey","value":"sourceId","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"15120300111","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"191"},{"key":"date","value":"Tue, 31 Oct 2023 11:56:09 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b022ca1b-c01b-4706-a31f-1f2e80c6b9ea"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent Cluster with sourceId [15120300111] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentClusterNotFound\"\n }\n}"}],"_postman_id":"ecb305ea-d622-4fa3-b756-284b89a255b3"}],"id":"c0a067f3-b2aa-47a6-8585-2aaf2eb44816","description":"

Cluster Products are the sellable goods in an e-commerce shop on the Propeller platform part of the parent Cluster.

Cluster Product Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller product id, auto-generated

What are lookup keys?

Fields

Name	Description	Type
names	Product name	array[LocalizedString]
language	Product default language	ISO 639-1
sku	Product SKU (code)	string
unit	The number of packages that need to be ordered when adding an item to the basket	integer
status	Product status	enum A=Available N=Not available T=Out of stock P=Phase out S=Presale R=Restricted
price	Sales price	decimal
costPrice	Cost price	decimal
suggestedPrice	Suggested/ advised price	decimal
priceDisplay	Type of price display	enum default = Only display price onrequest = Do not show price, show \"Price on request\" from = Show cheapest price fromfor = Show old (suggested) price vs. new price perpackage = price per type of package (e.g. Price from € 125.50 per box) peruom = Cheapest price per package unit (e.g. Price from € 125.50 per piece)
descriptions	Product description	array[LocalizedString]
shortName	Product short name	string
shortDescriptions	Product short descriptions	array[LocalizedString]
taxCode	Product tax code	enum H=High L=Low N=None
supplier	Product supplier	string
supplierCode	Product code as known to the product supplier	string
manufacturer	Manufacturer	string
oemCode	Product manufacturer code	string
eanCode	Product EAN code	string
minimumQuantity	Minimum orderable quantity	integer
package	Package (e.g. piece, sheet, etc.)	string
packageDescriptions	Description of package and package units inside a package (e.g. Box of 650 sheets of paper)	array[LocalizedString]
notes	Product notes/ remarks	array[LocalizedString]
sourceId	External system unique id	string
source	External system	string

Cluster Product Errors

This section describes error codes specific for the ClusterProduct resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
20012	ClusterProductExists	400	Cluster Product already exists	Cluster Product with such lookup key already exists
20013	ClusterProductNotFound	404	Cluster Product does not exist	Cluster Product with such lookup key not found
20014	ClusterProductNotAllowed	405	Cluster Product is not allowed	No permission for the Cluster Product

","_postman_id":"c0a067f3-b2aa-47a6-8585-2aaf2eb44816","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}},{"name":"Create Cluster","id":"016f252f-ced4-4580-970e-7ee4fed88996","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clusterConfigId\": 11,\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra\"\r\n }\r\n ],\r\n \"code\": \"15120300\",\r\n \"language\": \"NL\",\r\n \"sourceId\": \"15120300\",\r\n \"source\": \"RESTAPI\",\r\n \"parent\": {\r\n \"id\": 23409\r\n },\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/","description":"

Use this endpoint to create a single cluster. If a cluster is successfully created, the response will include the cluster id.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
parent	no
sourceId	no
source	only when `sourceId` is provided
clusterConfigId	no
code	no

Use this endpoint to retrieve cluster details by lookup key.

Optional. Use options to retrieve the cluster options. Use products to retrive cluster products etc.

\n","type":"text/plain"},"key":"expands","value":"translation,sources,parent,defaultProduct,options,products,clusterConfig"}],"variable":[{"id":"147687e9-1085-4e39-9d8b-c31d1af30959","description":{"content":"

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"537ffe5c-09e7-4fda-b947-3f31ee6f56a1","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"213","key":"lookupValue"}]}},"response":[{"id":"7c5d601c-a358-4097-9e58-fb48001dfabd","name":"Get Cluster by lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"210"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"410"},{"key":"date","value":"Tue, 31 Oct 2023 09:20:24 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"f38ea7f0-05bf-4de8-a80b-b2ff6bd12de0"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"clusterConfig\": {\n \"id\": 11\n },\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra\"\n }\n ],\n \"code\": \"15120300\",\n \"defaultobject_id\": \"\",\n \"id\": 210,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\n }\n ]\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"42951524-24e1-489a-a282-57bca3b63cdb","name":"Get Cluster by lookup key - 200 (expands)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue?expands=translation,sources,parent,defaultProduct,options,products,clusterConfig","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"translation,sources,parent,defaultProduct,options,products,clusterConfig","description":"Optional. Use `options` to retrieve the cluster options. Use `products` to retrive cluster products etc."}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"2436"},{"key":"date","value":"Tue, 31 Oct 2023 13:59:26 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"fe172ee4-a8c9-446e-9e22-bd9a36a53e3b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"products\": [\n {\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"FYR88\"\n }\n ],\n \"eanCode\": \"4004675044075\",\n \"price\": 555,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"DELL Precision 5530 Laptop - Z\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"base cluster product\"\n }\n ],\n \"oemCode\": \"FYR88\",\n \"manufacturer\": \"DELL\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"DELL Precision 5530 Laptop - Z\"\n }\n ],\n \"shortName\": \"DELL Precision 5530 Laptop\",\n \"sku\": \"FYR88\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 0.21,\n \"supplierCode\": \"FYR88\",\n \"status\": \"A\",\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"id\": 707971,\n \"unit\": 1,\n \"costPrice\": 400,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit\"\n }\n ],\n \"suggestedPrice\": 555,\n \"supplier\": \"RESTAPI\"\n }\n ],\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"CO.FYR88\"\n },\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"COFYR88\"\n }\n ],\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"clusterConfig\": {\n \"settings\": [],\n \"name\": \"OPTIONS_CLUSTER\",\n \"id\": 12\n },\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"DELL Precision 5530 Laptop - Z\"\n }\n ],\n \"options\": [\n {\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"K72334\"\n },\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"K72334000\"\n }\n ],\n \"defaultProduct\": \"\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n }\n ],\n \"isRequired\": false,\n \"id\": 214,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Muis\"\n }\n ]\n },\n {\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"KM636000\"\n }\n ],\n \"defaultProduct\": \"\",\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Toetsenbord\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Toetsenbord\"\n }\n ],\n \"isRequired\": false,\n \"id\": 216,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Toetsenbord\"\n }\n ]\n }\n ],\n \"code\": \"CO.FYR88\",\n \"defaultobject_id\": \"\",\n \"id\": 213,\n \"parent\": {\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"CLUSTERS\"\n }\n ],\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Clusters\"\n }\n ],\n \"id\": 23409,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ]\n },\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit\"\n }\n ]\n },\n \"messages\": [],\n \"total\": 1\n}"},{"id":"6ba4d91e-72e7-49db-a47c-7693c8cbdfcf","name":"Get Cluster by lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue?expands=translation,sources,parent,defaultProduct,options,products,clusterConfig","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue"],"query":[{"key":"expands","value":"translation,sources,parent,defaultProduct,options,products,clusterConfig"}],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"211"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"164"},{"key":"date","value":"Tue, 31 Oct 2023 09:21:30 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"bac16e57-eac8-47eb-a2cf-3ce012b14f1f"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20006\",\n \"messages\": [\n \"Cluster with id [211] not found\"\n ],\n \"status\": 404,\n \"code\": 20006,\n \"type\": \"ClusterNotFound\"\n }\n}"}],"_postman_id":"c522c86b-ba2d-4d71-be27-f4c69592df3d"},{"name":"Get Options by Cluster lookup key","id":"1272f938-9ddf-493d-9581-0d3e6d2f763c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options?expands=translation,sources,defaultProduct","description":"

Use this endpoint to retrieve cluster options by cluster lookup key.

Optional. Use translation to retrieve the cluster options translations. Use defaultProduct to retrive cluster options default products etc.

\n","type":"text/plain"},"key":"expands","value":"translation,sources,defaultProduct"}],"variable":[{"id":"7c2bbae1-0f91-4783-bae2-6ebf12b1f919","description":{"content":"

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"019a8e1a-bd54-47a0-97ba-eb492c3e4fe7","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"89","key":"lookupValue"}]}},"response":[{"id":"8f69d886-fdba-418a-8aae-87c40378f9ce","name":"Get Options by Cluster lookup key","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options"],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"89"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"453"},{"key":"date","value":"Tue, 31 Oct 2023 09:24:15 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"b965afd6-b3b3-4f02-9843-b0117a82d7c9"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"defaultProduct\": {\n \"id\": 450102\n },\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"First option\"\n }\n ],\n \"isRequired\": true,\n \"id\": 90,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"defaultProduct\": {\n \"id\": 661190\n },\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Second option\"\n }\n ],\n \"isRequired\": false,\n \"id\": 104,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"messages\": [],\n \"total\": 2\n}"},{"id":"e76a923f-2d5d-4515-80f0-6aebd08c2049","name":"Get Options by Cluster lookup key - 200 (expands)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options?expands=translation,sources,defaultProduct","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options"],"query":[{"key":"expands","value":"translation,sources,defaultProduct"}],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"89"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"1516"},{"key":"date","value":"Tue, 31 Oct 2023 09:24:57 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"ff42f492-4f67-46b0-a82c-2a3db1d62f15"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"sources\": [],\n \"defaultProduct\": {\n \"sources\": [],\n \"eanCode\": \"\",\n \"price\": 12,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

test change

\\r\\n\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"oemCode\": \"\",\n \"manufacturer\": \"\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"My first option\"\n }\n ],\n \"shortName\": \"\",\n \"sku\": \"conf-first-option-1\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 21,\n \"supplierCode\": \"\",\n \"status\": \"A\",\n \"package\": \"\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"id\": 450102,\n \"unit\": 1,\n \"costPrice\": 0,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"suggestedPrice\": 0,\n \"supplier\": \"\"\n },\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"First option\"\n }\n ],\n \"isRequired\": true,\n \"id\": 90,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"sources\": [],\n \"defaultProduct\": {\n \"sources\": [],\n \"eanCode\": \"\",\n \"price\": 0,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"oemCode\": \"\",\n \"manufacturer\": \"\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"My second option\"\n }\n ],\n \"shortName\": \"\",\n \"sku\": \"conf-second-option-2\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 21,\n \"supplierCode\": \"\",\n \"status\": \"A\",\n \"package\": \"\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"id\": 661190,\n \"unit\": 1,\n \"costPrice\": 0,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"suggestedPrice\": 0,\n \"supplier\": \"\"\n },\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ],\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Second option\"\n }\n ],\n \"isRequired\": false,\n \"id\": 104,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"messages\": [],\n \"total\": 2\n}"},{"id":"5e382993-56c4-4f48-a54a-398838015ad1","name":"Get Options by Cluster lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/options?expands=translation,sources,defaultProduct","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","options"],"query":[{"key":"expands","value":"translation,sources,defaultProduct"}],"variable":[{"key":"lookupKey","value":"id"},{"key":"lookupValue","value":"211"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"177"},{"key":"date","value":"Tue, 31 Oct 2023 09:25:29 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"77b46b5a-6353-4512-86e0-ba98b6e83793"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent Cluster with id [211] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentClusterNotFound\"\n }\n}"}],"_postman_id":"1272f938-9ddf-493d-9581-0d3e6d2f763c"},{"name":"Get Products by Cluster lookup key","id":"ae83bf5a-d63b-49ce-b3c3-f152e0d99b2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products?expands=translation,sources,surcharges,costprices","description":"

Use this endpoint to retrieve cluster products by cluster lookup key.

Optional. Use translation to retrieve the cluster products translations. Use surcharges to retrive cluster products surcharges etc.

\n","type":"text/plain"},"key":"expands","value":"translation,sources,surcharges,costprices"}],"variable":[{"id":"15c761ff-52e4-42bc-9052-e8b9e39c877a","description":{"content":"

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"96846514-a1e4-40c4-867a-00875bbe89d5","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"210","key":"lookupValue"}]}},"response":[{"id":"36f61784-e568-4a81-b24a-496b9cb46683","name":"Get Products by Cluster lookup key - 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"1877"},{"key":"date","value":"Tue, 31 Oct 2023 11:27:12 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"5772c436-d19a-4f31-9d6d-e4a2f19082dc"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"eanCode\": \"4004675044075\",\n \"price\": 1.49,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"

blawn

\\r\\n\"\n }\n ],\n \"oemCode\": \"151203\",\n \"manufacturer\": \"Schneider\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra blauw\"\n }\n ],\n \"shortName\": \"Balpen Slider XB extra blauw\",\n \"sku\": \"151203\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 21,\n \"supplierCode\": \"151203\",\n \"status\": \"A\",\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"id\": 707966,\n \"unit\": 1,\n \"costPrice\": 1.05,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"suggestedPrice\": 1.49,\n \"supplier\": \"RESTAPI\"\n },\n {\n \"eanCode\": \"4004675044037\",\n \"price\": 1.49,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"

rood

\\r\\n\"\n }\n ],\n \"oemCode\": \"151202\",\n \"manufacturer\": \"Schneider\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra rood\"\n }\n ],\n \"shortName\": \"Balpen Slider XB extra rood\",\n \"sku\": \"151202\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 21,\n \"supplierCode\": \"151202\",\n \"status\": \"A\",\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"id\": 707967,\n \"unit\": 1,\n \"costPrice\": 1.05,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"suggestedPrice\": 1.49,\n \"supplier\": \"RESTAPI\"\n }\n ],\n \"messages\": [],\n \"total\": 2\n}"},{"id":"8090974c-a417-4ac3-a093-bb38525530a3","name":"Get Products by Cluster lookup key - 200 (expands)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products?expands=translation,sources,surcharges,costprices","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products"],"query":[{"key":"expands","value":"translation,sources,surcharges,costprices","description":"Optional. Use `translation` to retrieve the cluster products translations. Use `surcharges` to retrive cluster products surcharges etc."}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"2079"},{"key":"date","value":"Tue, 31 Oct 2023 11:28:04 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"f377f9ff-0fe0-40f6-b28a-aafa2d513e5b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"surcharges\": [],\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"151203\"\n }\n ],\n \"eanCode\": \"4004675044075\",\n \"price\": 1.49,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"

blawn

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"suggestedPrice\": 1.49,\n \"supplier\": \"RESTAPI\"\n },\n {\n \"surcharges\": [],\n \"sources\": [\n {\n \"language\": \"NL\",\n \"source\": \"RESTAPI\",\n \"sourceId\": \"151202\"\n }\n ],\n \"eanCode\": \"4004675044037\",\n \"price\": 1.49,\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"notes\": [\n {\n \"language\": \"NL\",\n \"value\": \"

rood

\\r\\n\"\n }\n ],\n \"oemCode\": \"151202\",\n \"manufacturer\": \"Schneider\",\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra rood\"\n }\n ],\n \"shortName\": \"Balpen Slider XB extra rood\",\n \"sku\": \"151202\",\n \"taxCode\": \"H\",\n \"taxPercentage\": 21,\n \"costprices\": [],\n \"supplierCode\": \"151202\",\n \"status\": \"A\",\n \"package\": \"STK\",\n \"packageDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Stuks\"\n }\n ],\n \"id\": 707967,\n \"unit\": 1,\n \"costPrice\": 1.05,\n \"minimumQuantity\": 1,\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"

Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.

\\r\\n\"\n }\n ],\n \"suggestedPrice\": 1.49,\n \"supplier\": \"RESTAPI\"\n }\n ],\n \"messages\": [],\n \"total\": 2\n}"},{"id":"8f4bd5b7-847d-4ec5-b96d-a0bafa151752","name":"Get Products by Cluster lookup key - 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue/products?expands=translation,sources,surcharges,costprices","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue","products"],"query":[{"key":"expands","value":"translation,sources,surcharges,costprices","description":"Optional. Use `translation` to retrieve the cluster products translations. Use `surcharges` to retrive cluster products surcharges etc."}],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"211","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"177"},{"key":"date","value":"Tue, 31 Oct 2023 09:38:00 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"8b976a47-961b-40a4-98ce-7a1baab013c6"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20007\",\n \"messages\": [\n \"Parent Cluster with id [211] not found\"\n ],\n \"status\": 404,\n \"code\": 20007,\n \"type\": \"ParentClusterNotFound\"\n }\n}"}],"_postman_id":"ae83bf5a-d63b-49ce-b3c3-f152e0d99b2d"},{"name":"Update Cluster by lookup key","id":"cab6a016-f343-4eed-bd47-d465492c79db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pen Slider XB extra\"\r\n }\r\n ],\r\n \"code\": \"151203000\",\r\n \"sourceId\": \"151203000\",\r\n \"source\": \"RESTAPI\",\r\n \"clusterConfigId\": 11,\r\n \"parent\": {\r\n \"id\": 23409\r\n },\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point.\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pen Slider XB extra\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue","description":"

Use this endpoint to update a single cluster.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
parent	no
sourceId	no
source	only when `sourceId` is provided
clusterConfigId	no
code	no

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"e46934ae-5cc0-4ed3-872a-0ae55a41e2b4","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"210","key":"lookupValue"}]}},"response":[{"id":"f3648516-e91f-4e8b-9801-a188e1b08ebe","name":"Update Cluster by lookup key - 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pen Slider XB extra\"\r\n }\r\n ],\r\n \"code\": \"151203000\",\r\n \"sourceId\": \"151203000\",\r\n \"source\": \"RESTAPI\",\r\n \"clusterConfigId\": 11,\r\n \"parent\": {\r\n \"id\": 23409\r\n },\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point.\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pen Slider XB extra\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"210","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"760"},{"key":"date","value":"Tue, 31 Oct 2023 09:41:14 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"bf84a8e8-8aea-4192-99b9-65fffca284ff"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"names\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Pen Slider XB extra\"\n }\n ],\n \"code\": \"151203000\",\n \"sourceId\": \"151203000\",\n \"source\": \"RESTAPI\",\n \"clusterConfigId\": 11,\n \"parent\": {\n \"id\": 23409\n },\n \"descriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point.\"\n }\n ],\n \"shortDescriptions\": [\n {\n \"language\": \"NL\",\n \"value\": \"Balpen Slider XB extra\"\n },\n {\n \"language\": \"EN\",\n \"value\": \"Pen Slider XB extra\"\n }\n ],\n \"id\": 210\n },\n \"messages\": [\n \"Cluster updated\"\n ],\n \"total\": 1\n}"},{"id":"c8c40a10-16da-4c83-ac1f-9dcab79776b5","name":"Update Cluster by lookup key - 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pen Slider XB extra\"\r\n }\r\n ],\r\n \"code\": \"151203000\",\r\n \"sourceId\": \"151203000\",\r\n \"source\": \"RESTAPI\",\r\n \"clusterConfigId\": 11,\r\n \"parent\": {\r\n \"id\": 23409\r\n },\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point.\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Balpen Slider XB extra\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pen Slider XB extra\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"211","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"164"},{"key":"date","value":"Tue, 31 Oct 2023 09:41:33 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"91909ffd-bd9d-47b5-a243-bad30af291a9"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20006\",\n \"messages\": [\n \"Cluster with id [211] not found\"\n ],\n \"status\": 404,\n \"code\": 20006,\n \"type\": \"ClusterNotFound\"\n }\n}"}],"_postman_id":"cab6a016-f343-4eed-bd47-d465492c79db"},{"name":"Delete Cluster by lookup key","id":"dc71edef-054d-4840-a222-a63185d31759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue","description":"

Use this endpoint to delete cluster by lookup key.

Lookup key. Read more about cluster lookup keys

\n","type":"text/plain"},"type":"any","value":"id","key":"lookupKey"},{"id":"4773f56d-399b-456b-9abc-ae14bba54e58","description":{"content":"

The value of the key (id or sourceId)

\n","type":"text/plain"},"type":"any","value":"212","key":"lookupValue"}]}},"response":[{"id":"7e978bf2-156a-42b0-aea0-9d10bf88100d","name":"Delete Cluster by lookup key - 200","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"212","description":"The value of the key (id or sourceId)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"44"},{"key":"date","value":"Tue, 31 Oct 2023 09:43:04 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"716bdaeb-9ef7-402d-9fb3-ef76ee5fe20b"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"messages\": [\n \"Cluster deleted\"\n ]\n}"},{"id":"d4f4b33d-e3f7-49c9-915c-41856111feb9","name":"Delete Cluster by lookup key - 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.helice.cloud/api/g/v1/clusters/:lookupKey/:lookupValue","host":["https://api.helice.cloud/api/g/v1"],"path":["clusters",":lookupKey",":lookupValue"],"variable":[{"key":"lookupKey","value":"id","description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"key":"lookupValue","value":"213","description":"The value of the key (id or sourceId)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"return-format","value":"json"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"164"},{"key":"date","value":"Tue, 31 Oct 2023 09:43:19 GMT"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"},{"key":"x-request-id","value":"421ba89a-a9cf-4449-92e1-34ba209a81c3"},{"key":"Via","value":"1.1 google, 1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"moreInfo\": \"https://www.propel.us/docs/errors/20006\",\n \"messages\": [\n \"Cluster with id [213] not found\"\n ],\n \"status\": 404,\n \"code\": 20006,\n \"type\": \"ClusterNotFound\"\n }\n}"}],"_postman_id":"dc71edef-054d-4840-a222-a63185d31759"},{"name":"Bulk Clusters by sourceId","id":"91889a10-d382-41e8-b736-e6a0280725f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clusters\": [\r\n {\r\n \"clusterConfigId\": 9,\r\n \"language\": \"NL\",\r\n \"sourceId\": \"030333335\",\r\n \"source\": \"RESTAPI\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Cluster 5\"\r\n }\r\n ],\r\n \"code\": \"030004\",\r\n \"parent\": {\r\n \"sourceId\": \"CLUSTERS\"\r\n },\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Cluster 5\"\r\n }\r\n ],\r\n \"options\": [\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Third cluster option 2\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Third cluster option 2\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"030997\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Third cluster option 2\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Third cluster option 2\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Third cluster option 2\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Third cluster option 2\"\r\n }\r\n ],\r\n \"isRequired\": true\r\n },\r\n {\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Third cluster option 2\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Third cluster option 2\"\r\n }\r\n ],\r\n \"language\": \"NL\",\r\n \"sourceId\": \"030998\",\r\n \"source\": \"RESTAPI\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Third cluster option 2\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Third cluster option 2\"\r\n }\r\n ],\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Third cluster option 2\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Third cluster option 2\"\r\n }\r\n ],\r\n \"isRequired\": false\r\n }\r\n ],\r\n \"products\": [\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70888\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD7011114\"\r\n },\r\n {\r\n \"language\": \"NL\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"sku\": \"NCABD70004\",\r\n \"status\": \"A\",\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.
De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.
Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends).\"\r\n }\r\n ],\r\n \"shortName\": \"Edge 1030 Fietscomputer\",\r\n \"shortDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.\"\r\n }\r\n ],\r\n \"supplier\": \"TECHDATA\",\r\n \"supplierCode\": \"NCABD70004\",\r\n \"oemCode\": \"NCABD70004\",\r\n \"eanCode\": \"0753759256289\",\r\n \"taxCode\": \"H\",\r\n \"price\": 599.95,\r\n \"unit\": 1,\r\n \"minimumQuantity\": 1,\r\n \"manufacturer\": \"Garmin\",\r\n \"costPrice\": 400.95,\r\n \"suggestedPrice\": 580.00,\r\n \"package\": \"STK\",\r\n \"packageDescriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Stuks\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Pieces\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Edge 1030 Fietscomputer\"\r\n },\r\n {\r\n \"language\": \"EN\",\r\n \"value\": \"Edge 1030 Bike computer\"\r\n }\r\n ],\r\n \"source\": \"TECHDATA\",\r\n \"sourceId\": \"NCABD7022225\"\r\n }\r\n ]\r\n },\r\n {\r\n \"clusterConfigId\": 9,\r\n \"language\": \"NL\",\r\n \"sourceId\": \"030777\",\r\n \"source\": \"RESTAPI\",\r\n \"names\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Cluster 6\"\r\n }\r\n ],\r\n \"code\": \"030004\",\r\n \"parent\": {\r\n \"sourceId\": \"CLUSTERS\"\r\n },\r\n \"descriptions\": [\r\n {\r\n \"language\": \"NL\",\r\n \"value\": \"Cluster 6\"\r\n }\r\n ],\r\n }\r\n ],\r\n \"directives\": [\r\n {\r\n \"operation\": \"skipIfNotEmpty\",\r\n \"fields\": [\r\n \"names\",\r\n \"descriptions\"\r\n ]\r\n },\r\n {\r\n \"operation\": \"skipMoveOnUpdate\",\r\n \"fields\": []\r\n },\r\n {\r\n \"operation\": \"mergeTranslationsOnUpdate\",\r\n \"fields\": []\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.helice.cloud/api/g/v1/clusters/bulk/sourceId","description":"

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
categories (array of category objects)	yes
sourceId	yes
source	yes
language	yes
names	yes
descriptions	no
shortDescriptions	no
attributes Read more about attributes	no
parent	yes

For more details on attributes field, read this.

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing category that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing category in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a category that are not provided in the payload	empty array

What are directives?

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go here.

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required
categories (array of category objects)	yes
sourceId	yes
source	yes
language	yes
names	yes
descriptions	no
shortDescriptions	no
attributes Read more about attributes	no
parent	yes

For more details on attributes field, read this.

Directives

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing category that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing category in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a category that are not provided in the payload	empty array

What are directives?

Clusters are groups of products and/or options in an e-commerce shop on the Propeller platform. The Cluster API can be used to consult, create, update or delete a Cluster, Cluster Option or Cluster Product.

Cluster Lookup keys

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
id	integer	Propeller cluster id, auto-generated
sourceId	string	External system unique id. `sourceId` should be combined with `source`

What are lookup keys?

Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type
clusterConfigId	Cluster config id	integer
sourceId	External system unique id	string
source	External system	string
language	Cluster default language	ISO 639-1
code	Cluster code	string
names	Cluster name	array[LocalizedString]
descriptions	Cluster description	array[LocalizedString]
shortDescriptions	Cluster short description	array[LocalizedString]
parent	Parent category	JSON object that identifies the parent. `id` or `sourceId` in combination with `source`

Cluster Errors

This section describes error codes specific for the Cluster resource.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error Type	Status Code	Message	Reason
20004	ClusterExists	400	Cluster already exists	Cluster with such lookup key already exists
20005	ClusterMultipleFound	400	Multiple clusters found. Please provide additional filters	Multiple clusters with such lookup key exist
20006	ClusterNotFound	404	Cluster does not exist	Cluster with such lookup key not found
20007	ParentClusterNotFound	404	Parent cluster not found	Parent cluster with such lookup key not found.
20008	ClusterNotAllowed	405	Cluster is not allowed	No permission for the cluster

","_postman_id":"2ac6b33f-c611-4870-aad4-f147871b1e66","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","id":"51a602d1-ce55-403e-9f53-25eeeddd6dbe","name":"API Reference (OUTDATED) -> https://docs.propeller-commerce.com","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"ce68a312-3860-44ef-882c-63aadb3685a3","type":"text/javascript","exec":["var CryptoJS = require(\"crypto-js\")","","const tokenUrl = pm.environment.get(\"tokenURL\");","const clientKey = pm.environment.get(\"key\");","const clientSecret = pm.environment.get(\"secret\");","","const rawStr = CryptoJS.enc.Utf8.parse(clientKey + \":\" + clientSecret)","const base64Authentication = CryptoJS.enc.Base64.stringify(rawStr)","","const getTokenRequest = {"," method: 'POST',"," url: tokenUrl,"," body: {"," mode: 'urlencoded',"," urlencoded: ["," {key: \"grant_type\", value: \"client_credentials\", disabled: false},"," ]"," },"," header: ["," { key: 'Authorization', value: 'Basic ' + base64Authentication }"," ]","};","","pm.sendRequest(getTokenRequest, (err, response) => {"," const jsonResponse = response.json();"," if (jsonResponse.Error) {"," console.log(jsonResponse.Error);"," } else {"," const newAccessToken = jsonResponse.access_token;"," pm.variables.set('access_token', newAccessToken);"," }","});"]}},{"listen":"test","script":{"id":"ea6bc31b-d804-47a5-bfca-8bee9b30d3f9","type":"text/javascript","exec":["// pm.test(\"Status code is 200\", function () {","// pm.response.to.have.status(200);","// });","","// pm.test(\"Content-Type header is application/json\", () => {","// pm.expect(pm.response.headers.get('Content-Type')).to.eql('application/json;charset=UTF-8');","// });","","// let jsonData = pm.response.json();","// pm.test(\"Response body does not return error message\", function () {","// pm.expect(jsonData.error).to.be.oneOf([false, undefined]);","","// }); ",""]}}],"variable":[{"key":"basePath","value":"https://api.helice.cloud/api/g/v1"},{"key":"tokenURL","value":"https://api.helice.cloud/oauth2/token"}]}

HTTP methods

Authentication

Request an access token

Lookup keys

Expanding resources

Pagination

Page

Offset

Response

Errors

Error response

Localized String

Bulk endpoints

Directives

Usecases

Usergroups - users bulk import

Order export

Fields

Fields

Directives

Fields

Directives

Category Lookup keys

Fields

Category Errors

Fields

Fields

Directives

Fields

Directives

Product text filter

Product range filter

Product price filter

Product date filter

Product Lookup keys

Fields

Product Errors

Fields

Fields

Fields

Use cases

Fields

Fields

Fields

Fields

Date filter

User Lookup keys

Fields

User Errors

Fields

Fields

Fields

Use cases

Fields

Fields

Directives

Fields

Directives

Date filter

Usergroup Lookup keys

Fields

Usergroup Errors

Fields

Fields

Fields

Use cases

Fields

Fields

Directives

Fields

Directives

Date filter

Company Lookup keys

Fields

Company Errors

Use cases

Fields

Fields

Fields

Date filter