Skip to content
Ideasoft
Getting Started

FAQ

What are the Object, Operation and Service concepts?

  • Object: The set of properties holding all the values of a concept in the e-commerce system (product, order, member, etc.).
  • Property: An attribute holding a single value belonging to an object.
  • Operation: A single HTTP request that performs an action such as creating, deleting, modifying or viewing an object. In some exceptional cases it also performs operations without an object relation (e.g. clearing a cache).
  • Service: A group of operations bundling similar actions on an object.

What is an Access Token? What is it used for? How is it sent?

An Access Token is the key you must use to communicate securely with your Ideasoft online store via the API. The Ideasoft API has an OAuth2-compliant authorization mechanism. Since it is a Bearer-type token it must be sent in the Authorization header:

Code
Authorization: Bearer <token>

See the Authentication document for everything about obtaining an Access Token.

What is a Redirect URI? What is it used for?

The Redirect URI is the address where the code value — the first step of the access token flow — is delivered after your API application is authorized, and where the authorizing user is also redirected. It is important that you provide a valid address under your control.

What is a Refresh Token? How is it used?

The Refresh Token is a renewal key delivered together with the Access Token. With it, you can obtain a new Access and Refresh Token in a single request. An Access Token is valid for 24 hours; once it expires, use the Refresh Token instead of repeating the authorization steps. The Refresh Token is valid for 2 months, but it expires the moment it is used and is replaced with a new one.

What is the "Too many requests" error?

The 429 Too Many Requests error is returned when you send requests too frequently in a row. The request-rate limit is a dynamically changing value, so no fixed interval can be given. To keep your requests from being cut off, we recommend designing your code to pause briefly and resend a request that receives this error.

Can you provide C# sample code?

The Ideasoft API does not currently have an SDK; however, the examples on the API reference pages can be viewed in multiple languages. You can also generate automatic code blocks for requests you build with tools such as Postman.

How do I add a variant?

Variant products on Ideasoft are products linked to a parent product. To make a product a variant of another, you must first have created a Variant Group, a Variant, and a parent Product you want to attach the variant to. You then link all of these with the Variant Product Links service; once the link is created, the variant exists on the parent product.

How do I add product images? Can I use a URL?

To add images to your products you must use the Product Image Create service. Images must be sent in base64 format; adding via URL is not supported. The service contains an example request.

Can product images be updated?

No. The Product Images service has no update operation. To change a product's image you must delete the existing image and create a new one in its place.

Is a webhook sent again if delivery fails?

It depends on the response code. If your endpoint returns 5xx, the request is retried (3 attempts by default). On 3xx, 4xx or a timeout it is not retried and the delivery is dropped. Your webhook subscription is not removed in that case; later events are still sent. See Delivery and Retries for details.

Last modified on