This page contains documentation for the Skysales API.
You will need a valid access_token
to be able to access these functions.
The access_token
must be included in the header for every API call.
<access_token>
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
productCategory | string | Text label |
description | string | Description |
object (Media) | Deprecated: use the "pictures" field instead. |
|
pictures | array<object> (Media) | Array of image files for this category |
sortOrder | number | Sorting order |
children | array<object> (ProductCategory) | Optional sorted array of connected child categories |
Parameter | Type | Description |
---|---|---|
id | string | ID |
title | string | Original filename |
variant | Object | (Only for imagefiles in the children Array) Specification for variant of the original image |
mediaType | string | Media type (MIME type) |
url | string | Filepath |
children | Array<Media> | (Only for imagefiles) Array with compressed variants of the original image |
<access_token>
Parameter | Type | Description |
---|---|---|
id | string | ID, can be either the "id" or "customId" value |
Parameter | Type | Description |
---|---|---|
string | Deprecated: this parameter is no longer needed. |
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
productCategory | string | Text label |
description | string | Description |
object (Media) | Deprecated: use the "pictures" field instead. |
|
pictures | array<object> (Media) | Array of image files for this category |
sortOrder | number | Sorting order |
children | array<object> (ProductCategory) | Optional sorted array of connected child categories |
Parameter | Type | Description |
---|---|---|
id | string | ID |
title | string | Original filename |
variant | Object | (Only for imagefiles in the children Array) Specification for variant of the original image |
mediaType | string | Media type (MIME type) |
url | string | Filepath |
children | Array<Media> | (Only for imagefiles) Array with compressed variants of the original image |
<access_token>
Parameter | Type | Description |
---|---|---|
s | string | (Optional) URI encoded search text |
cat | string | (Optional) Filter by URI encoded product category id, can be either the "id" or "customId" value. Note: Using "id" will produce slightly faster results. |
page | string | Starting page (default = "1") |
limit | string | Results per page (default = "24") |
sort_by | string | Sort by field (default = "title") |
sort_desc | string | Sort descending, can be "1" or "0" (default = "0") |
Parameter | Type | Description |
---|---|---|
docs | array<object> (Product) | Array of resulting objects for the current page |
total | number | Total number of results found |
limit | number | Results per page |
page | number | Current page |
pages | number | Total number of pages |
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
articleNumber | string | Article number / SKU |
title | string | Title |
subtitle | string | Subtitle |
description | string | Description |
tags | array<object> (Phrase) | Array of tags for this product |
productCategories | array<object> (ProductCategory) | Array of categories where this product is listed |
pictures | array<object> (Media) | Array of image files for this product |
unitType | object (UnitType) | Contains the unit type for this product |
isPackageProduct | boolean | If true, then this product is a collection of other products (listed under productAdditions). |
Parameter | Type | Description |
---|---|---|
id | string | ID |
value | string | The phrase/text label |
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
productCategory | string | Text label |
description | string | Description |
object (Media) | Deprecated: use the "pictures" field instead. |
|
pictures | array<object> (Media) | Array of image files for this category |
sortOrder | number | Sorting order |
children | array<object> (ProductCategory) | Optional sorted array of connected child categories |
Parameter | Type | Description |
---|---|---|
id | string | ID |
title | string | Original filename |
variant | Object | (Only for imagefiles in the children Array) Specification for variant of the original image |
mediaType | string | Media type (MIME type) |
url | string | Filepath |
children | Array<Media> | (Only for imagefiles) Array with compressed variants of the original image |
<access_token>
Parameter | Type | Description |
---|---|---|
s | string | (Optional) search text |
cat | string | (Optional) Filter by product category id, can be either the "id" or "customId" value. Note: Using "id" will produce slightly faster results. |
tags | Array<string> | (Optional) Filter by array of product tags. Each item in the array must be either the "id" or "value" field from a product tag. Note: Using "id" will produce slightly faster results. |
page | number | Starting page (default = 1) |
limit | number | Results per page (default = 24) |
sort_by | string | Sort by field (default = "title") |
sort_desc | boolean | Sort descending (default = false) |
Parameter | Type | Description |
---|---|---|
docs | array<object> (Product) | Array of resulting objects for the current page |
total | number | Total number of results found |
limit | number | Results per page |
page | number | Current page |
pages | number | Total number of pages |
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
articleNumber | string | Article number / SKU |
title | string | Title |
subtitle | string | Subtitle |
description | string | Description |
tags | array<object> (Phrase) | Array of tags for this product |
productCategories | array<object> (ProductCategory) | Array of categories where this product is listed |
pictures | array<object> (Media) | Array of image files for this product |
unitType | object (UnitType) | Contains the unit type for this product |
isPackageProduct | boolean | If true, then this product is a collection of other products (listed under productAdditions). |
Parameter | Type | Description |
---|---|---|
id | string | ID |
value | string | The phrase/text label |
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
productCategory | string | Text label |
description | string | Description |
object (Media) | Deprecated: use the "pictures" field instead. |
|
pictures | array<object> (Media) | Array of image files for this category |
sortOrder | number | Sorting order |
children | array<object> (ProductCategory) | Optional sorted array of connected child categories |
Parameter | Type | Description |
---|---|---|
id | string | ID |
title | string | Original filename |
variant | Object | (Only for imagefiles in the children Array) Specification for variant of the original image |
mediaType | string | Media type (MIME type) |
url | string | Filepath |
children | Array<Media> | (Only for imagefiles) Array with compressed variants of the original image |
<access_token>
Parameter | Type | Description |
---|---|---|
id | string | ID, can be either the "id" or "customId" value |
Parameter | Type | Description |
---|---|---|
string | Deprecated: this parameter is no longer needed. |
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
articleNumber | string | Article number / SKU |
title | string | Title |
subtitle | string | Subtitle |
description | string | Description |
tags | array<object> (Phrase) | Array of tags for this product |
productCategories | array<object> (ProductCategory) | Array of categories where this product is listed |
pictures | array<object> (Media) | Array of image files for this product |
unitType | object (UnitType) | Contains the unit type for this product |
isPackageProduct | boolean | If true, then this product is a collection of other products (listed under productAdditions). |
productParams | array<object> (ProductParam) | Array of properties for this product |
media | array<object> (Media) | Array of media files for this product |
productOptions | array<object> (ProductOption) | Array of available product options. (Only available on products where isPackageProduct=false) |
productAdditions | array<object> (ProductAddition) | Array of available product additions. Some may be optional and some mandatory. (Only available on products where isPackageProduct=true) |
relatedProducts | array<object> (Product) | Array of related or similar products, if available |
Parameter | Type | Description |
---|---|---|
id | string | ID |
value | string | The phrase/text label |
Parameter | Type | Description |
---|---|---|
id | string | ID |
customId | string | Custom human-readable ID |
productCategory | string | Text label |
description | string | Description |
object (Media) | Deprecated: use the "pictures" field instead. |
|
pictures | array<object> (Media) | Array of image files for this category |
sortOrder | number | Sorting order |
children | array<object> (ProductCategory) | Optional sorted array of connected child categories |
Parameter | Type | Description |
---|---|---|
id | string | ID |
title | string | Original filename |
variant | Object | (Only for imagefiles in the children Array) Specification for variant of the original image |
mediaType | string | Media type (MIME type) |
url | string | Filepath |
children | Array<Media> | (Only for imagefiles) Array with compressed variants of the original image |
Parameter | Type | Description |
---|---|---|
id | string | ID |
unitType | string | Symbol |
unitDescription | string | Description |
Parameter | Type | Description |
---|---|---|
id | string | ID |
param | string | Parameter name |
value | string | Parameter text |
Parameter | Type | Description |
---|---|---|
id | string | ID |
option | string | Title |
choices | array<object> (ProductOptionChoice) | Array of available choices |
Parameter | Type | Description |
---|---|---|
id | string | ID |
label | string | Title |
customChoice | boolean | If true, then the customer can provide a custom value for this choice |
Parameter | Type | Description |
---|---|---|
id | string | ID |
addition | string | Title |
optional | boolean | If true, then this product addition is optional |
choices | array<object> (ProductAdditionChoice) | Array of available choices |
Parameter | Type | Description |
---|---|---|
id | string | ID |
product | object (Product) | The product for this choice |
width | number | Prefilled width, if available |
height | number | Prefilled height, if available |
length | number | Prefilled length, if available |
quantity | number | Prefilled quantity, if available |
<access_token>
Parameter | Type | Description |
---|---|---|
offernr | string | OfferNumber |
Parameter | Type | Description |
---|---|---|
url | string | (Optional) URL to product page |
image | string | (Optional) URL to product image / thumb |
text | string | Product title or custom text label |
currency | string | Currency code (default = "SEK") |
rows | array<object> (CustomOrderItemRow) | Array of specification rows |
Parameter | Type | Description |
---|---|---|
sku | string | Article number / SKU |
supplierSku | string | (Optional) The suppliers article number / SKU |
text | string | Product title or custom text label |
price | number | Price per item (excl. VAT) |
supplierPrice | number | (Optional) The suppliers price per item (excl. VAT) |
vat | number | VAT percent (default = 25) |
unit | string | (Optional) Custom unit label (Currently not in use) |
quantity | number | Number of items |
Parameter | Type | Description |
---|---|---|
id | string | ID |
title | string | Product title or custom text label |
url | string | URL to product page |
imageUrl | string | URL to product image / thumb |
productSku | string | Product article number / SKU |
isPackageProduct | boolean | If true, then this is a parent item for other items. |
productCurrency | object (Currency) | Contains the currency used for productItemPrice / productPrice |
productExchangeRate | number | Exchange rate used for productCurrency |
productItemPrice | number | Product price per item (excl. VAT) |
productPrice | number | Calculated total product price (excl. VAT), based on productItemPrice and quantity |
supplierSku | string | Supplier article number / SKU |
supplierCurrency | object (Currency) | Contains the currency used for supplierItemPrice / supplierPrice |
supplierExchangeRate | number | Exchange rate used for supplierCurrency |
supplierItemPrice | number | Supplier price per item (excl. VAT) |
supplierPrice | number | Calculated total supplier price (excl. VAT), based on supplierItemPrice and quantity |
currency | object (Currency) | Contains the currency used for price |
exchangeRate | number | Exchange rate used for currency |
unitType | object (UnitType) | Contains the unit type for this item |
customUnit | string | Custom unit label for this item (Currently not in use) |
specifications | array<object> (OrderItemSpecification) | Array of specs for this item |
price | number | Final, currency converted, price (excl. VAT) for this item, based on productPrice, quantity and discount |
vat | number | VAT percentage for this item |
discount | number | Discount percentage for this item |
subOrderItems | array<object> (OrderItem) | Array of children to this item. Only available when isPackageProduct=true |
Parameter | Type | Description |
---|---|---|
width | number | Width. Only available for certain unit types |
height | number | Height. Only available for certain unit types |
length | number | Length. Only available for certain unit types |
quantity | number | Quantity |
comment | string | Comment |
<access_token>
Parameter | Type | Description |
---|---|---|
offernr | string | OfferNumber |
Parameter | Type | Description |
---|---|---|
text | string | Text label |
price | number | Price per item (excl. VAT) |
vat | number | VAT percent (default = 25) |
quantity | number | Number of items |
Parameter | Type | Description |
---|---|---|
id | string | ID |
comment | string | Comment |
currency | object (Currency) | Contains the currency used for price |
exchangeRate | number | Exchange rate used for currency |
unitType | object (UnitType) | Contains the unit type for this item |
specifications | array<object> (OrderItemSpecification) | Array of specs for this item |
customItemPrice | number | Price per item (excl. VAT) |
price | number | Final price (excl. VAT) for this item, based on customItemPrice and quantity |
vat | number | VAT percentage for this item |
Parameter | Type | Description |
---|---|---|
width | number | Width. Only available for certain unit types |
height | number | Height. Only available for certain unit types |
length | number | Length. Only available for certain unit types |
quantity | number | Quantity |
comment | string | Comment |
<access_token>
Parameter | Type | Description |
---|---|---|
id | string | ID |
type | string | Type code |
sampleType | string | Type of samples, currently only supports: "LightValue" |
description | string | Description |
factory | string | Factory / Manufacturing plant |
workstation | string | Workstation |
conductedBy | string | Conducted by |
timeOfTest | Date | Time of test |
manufactCycle | string | Manufacturing cycle |
orderNumber | string | Sales ordernumber |
serialNumber | string | Serialnumber |
converterId | string | Converter ID |
testSamples | array<object> (TestSample) | Array of test samples |
Parameter | Type | Description |
---|---|---|
id | string | ID |
name | string | Sample name |
date | Date | Sample date and time |
lightValue | string | Light value |
<access_token>
Parameter | Type | Description |
---|---|---|
id | string | ID |
Parameter | Type | Description |
---|---|---|
id | string | ID |
type | string | Type code |
sampleType | string | Type of samples, currently only supports: "LightValue" |
description | string | Description |
factory | string | Factory / Manufacturing plant |
workstation | string | Workstation |
conductedBy | string | Conducted by |
timeOfTest | Date | Time of test |
manufactCycle | string | Manufacturing cycle |
orderNumber | string | Sales ordernumber |
serialNumber | string | Serialnumber |
converterId | string | Converter ID |
testSamples | array<object> (TestSample) | Array of test samples |
Parameter | Type | Description |
---|---|---|
id | string | ID |
name | string | Sample name |
date | Date | Sample date and time |
lightValue | string | Light value |
<access_token>
Parameter | Type | Description |
---|---|---|
type | string | Type code |
sampleType | string | Must be set to: "LightValue" |
description | string | Description |
factory | string | Factory / Manufacturing plant |
workstation | string | Workstation |
conductedBy | string | Conducted by |
timeOfTest | Date | Time of test |
manufactCycle | string | Manufacturing cycle |
orderNumber | string | Sales ordernumber |
serialNumber | string | Serialnumber |
converterId | string | Converter ID |
testSamples | array<object> | Array of test samples |
Parameter | Type | Description |
---|---|---|
id | string | ID |
type | string | Type code |
sampleType | string | Type of samples, currently only supports: "LightValue" |
description | string | Description |
factory | string | Factory / Manufacturing plant |
workstation | string | Workstation |
conductedBy | string | Conducted by |
timeOfTest | Date | Time of test |
manufactCycle | string | Manufacturing cycle |
orderNumber | string | Sales ordernumber |
serialNumber | string | Serialnumber |
converterId | string | Converter ID |
testSamples | array<object> (TestSample) | Array of test samples |
Parameter | Type | Description |
---|---|---|
id | string | ID |
name | string | Sample name |
date | Date | Sample date and time |
lightValue | string | Light value |