Product Management API (1.0)

The Product Management API allows you to search for products

Common Authorization Parameters

Each request is authorized using username and password fields passed either as query parameters (for GET/POST operations) or part of the application/x-www-form-urlencoded body (for POST operations).

Error Codes

Each response contains a response_status field containing the following error codes.

Code Severity Description
10001 SUCCESS
30001 ERROR Authentication failed
31000 ERROR API not enabled on your site
40004 WARNING Product ID Not Found
50002 ERROR No conditions specified
50003 ERROR Condition N 'field' is missing
50003 ERROR Condition N 'condition' is missing
50003 ERROR date1 is invalid
50003 ERROR date2 is invalid

Product Search

Retrieve a list of products based upon your search parameters. The maximum number of rows returned is 100. Use the returned "total" value to determine if you need to paginate using the offset parameter.
You can specify multiple conditions in which case the conditions will be join with a logical 'AND'.
To use multiple conditions you will need to pass the parameters using the multi condition parameter format:

conditions[n][parameter name]

where n starts at 1 and "parameter name" is the name of the parameter as below.

Request Body schema: application/x-www-form-urlencoded
field
required
integer

The Field the condition is tested against.
Multi condition parameter format: conditions[n][field]

Values

  • 1: Product Code
  • 2: Product Name
  • 3: Supplier
  • 4: Product Id
  • 5: Date Modified
condition
required
integer

The logical test to use.
Multi condition parameter name: conditions[n][condition]

Values

  • 1: ==
  • 2: !=
  • 3: <
  • 4: >
  • 5: <=
  • 6: >=
  • 7: Between
date1
string

The date to test against (Required when field is a date).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date1]

date2
string

The end date to test against (Required when field is a date and condition is 7: Between).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date2]

string
string

The string to test against (Required when field is Product Code or Name).
Multi condition parameter name: conditions[n][string]

limit
integer [ 0 .. 100 ]
Default: 100

Limit the number of results returned. The maximum limit is 100

offset
integer
Default: 0

Offset of the results to allow pagination

sortby
integer
Default: 6

What field to sort the results by
Values

  • 1: Product Code
  • 2: Product Name
  • 3: Product Supplier
  • 4: Product Id
  • 5: Date Modified
  • 6: Sort Position

Responses

Response Schema: application/json
object (ResponseStatus)
Array of objects (Product)

An array of product objects

total
integer

The total number of products found

Request samples

Content type
application/x-www-form-urlencoded
field=5&condition=4&date1=2018-02-01T00%3A00%3A00

Response samples

Content type
application/json
{
  • "response_status": {
    },
  • "products": [
    ],
  • "total": 2
}

Get Product

Get a single product or a list of products

query Parameters
id
number
Example: id=234

the id of the product

ids
string
Example: ids=1234567,124234,23434

a comma separated list of product ids (max 100)

Responses

Response Schema: application/json
required
object (ResponseStatus)
object (ProductDetailed)
Array of objects (ProductDetailed)

An array of product details when the ids parameter is used

Response samples

Content type
application/json
Example
{
  • "response_status": {
    },
  • "product": {
    }
}