Download OpenAPI specification:Download
You can use the MyCashflow API to integrate your MyCashflow online store with a number of third-party applications, for example CRMs and accounting software.
MyCashflow API is only available for the following plans:
NOTE: MyCashflow also has support for Zapier for your more lightweight integration needs. See further info at https://support.mycashflow.com/en/user-guide/zapier.
MyCashflow API is recommended to be used in backend clients. Making API credentials public in frontend clients carries many security issues.
Get started using the API by going through the following documentation. This document will be updated whenever changes to the API are made.
All major versions of the API have their own endpoints. The endpoint defines the server path that receives your API requests and responds to them. The MyCashflow API endpoints are defined according to the following scheme:
https://STORENAME.mycashflow.fi/api/v1
The last part of the endpoint address defines the targeted API version.
The API is only available over the default domain
https://STORENAME.mycashflow.fi
. Calls to custom domains are
ignored.
Do not include a trailing slash in the request URL. The API will return an error if a trailing slash is present.
First, install the API extension on the Account » Extensions page of your store's admin panel.
Once you have installed the API extension, you need to create an API user. The API user account's credentials are used to authenticate requests to the API (further details on authentication can be found in the AUTHORIZATIONS section of each API endpoint in this document).
The MyCashflow API uses JSON to deliver any data returned by requests to the API.
All responses with content have the following HTTP headers:
Content-Type: application/json
Content-Length
Requests may return the following HTTP status response codes:
Success:
200 Ok
201 Created
204 No content
Client error:
400 Bad Request
401 Unauthorized
404 Not Found
409 Conflict
422 Unprocessable Entity
Server error:
500 Internal Server Error
503 Service Unavailable
5xx Other connection errors
The API returns the response body for requests in JSON format – provided that the requested resource was found:
422 Unprocessable Entity
error was encountered while
processing your request, the errors element will also be present in the response
body.MyCashflow API uses two methods of reporting errors:
See section Headers of the Responses chapter for possible error codes.
errors
JSON element: if the request contains errors, the response JSON will contain the errors
element, which provides details about the error.
For example, errors will be reported as JSON, if you try to add a product without a name, or insert unsupported data into certain fields.
Below is a JSON example of an error message returned by a PATCH
request. Each field affected by errors will have its own array of error messages, with the field name as a key:
expand | string Value: "translations" Comma-separated list of expandable sub-resources. |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "code": "group-code",
- "title": "My banner group",
- "translations": [
- {
- "language": "en",
- "title": "My banner group"
}, - {
- "language": "fi",
- "title": "Banneriryhmä"
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
code | string The banner group code. Can be used to identify the banner group in theme files. |
title | string The banner group title. If present in both the root of the request body and the |
translations | Array of objects Array of translations for translatable fields. |
{- "code": "group-code",
- "title": "My banner group",
- "translations": [
- {
- "language": "en",
- "title": "My banner group"
}, - {
- "language": "fi",
- "title": "Banneriryhmä"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "code": "group-code",
- "title": "My banner group",
- "translations": [
- {
- "language": "en",
- "title": "My banner group"
}, - {
- "language": "fi",
- "title": "Banneriryhmä"
}
]
}
}
bannerGroupID required | integer >= 1 Unique identifier for the banner group |
expand | string Value: "translations" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "code": "group-code",
- "title": "My banner group",
- "translations": [
- {
- "language": "en",
- "title": "My banner group"
}, - {
- "language": "fi",
- "title": "Banneriryhmä"
}
]
}
}
bannerGroupID required | integer >= 1 Unique identifier for the banner group |
code | string The banner group code. Can be used to identify the banner group in theme files. |
title | string The banner group title. If present in both the root of the request body and the |
translations | Array of objects Array of translations for translatable fields. |
{- "code": "group-code",
- "title": "My banner group",
- "translations": [
- {
- "language": "en",
- "title": "My banner group"
}, - {
- "language": "fi",
- "title": "Banneriryhmä"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "code": "group-code",
- "title": "My banner group",
- "translations": [
- {
- "language": "en",
- "title": "My banner group"
}, - {
- "language": "fi",
- "title": "Banneriryhmä"
}
]
}
}
expand | string Enum: "translations" "visibilities" Comma-separated list of expandable sub-resources. |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
group_id | integer The ID of the banner group this banner belongs to |
sort | integer A number that represents the banner's position in the banner group relative to other banners. |
code | string The banner's individual code. Set in the banner form's Codename field. |
title | string The banner's title. If present in both the root of the request body and the |
content | string The banner's text/HTML content. If present in both the root of the request body and the |
visible_from | string <date-time> The date when the banner becomes visible in the store. |
visible_to | string <date-time> The date when the banner is hidden. |
file | string The banner image. Enter only the filename of the image. The image file must reside in the store's file archive, and cannot be sent in the same request, with which you create or update a banner. The default path of the images is the files/tuotekuvat directory. |
link | string The banner link. If present in both the root of the request body and the |
translations | Array of objects An array of translation objects that contain content for any multilingual fields of the banner. |
{- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
}
bannerID required | integer >= 1 Unique identifier for the banner |
expand | string Enum: "translations" "visibilities" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
}
bannerID required | integer >= 1 Unique identifier for the banner |
group_id | integer The ID of the banner group this banner belongs to |
sort | integer A number that represents the banner's position in the banner group relative to other banners. |
code | string The banner's individual code. Set in the banner form's Codename field. |
title | string The banner's title. If present in both the root of the request body and the |
content | string The banner's text/HTML content. If present in both the root of the request body and the |
visible_from | string <date-time> The date when the banner becomes visible in the store. |
visible_to | string <date-time> The date when the banner is hidden. |
file | string The banner image. Enter only the filename of the image. The image file must reside in the store's file archive, and cannot be sent in the same request, with which you create or update a banner. The default path of the images is the files/tuotekuvat directory. |
link | string The banner link. If present in both the root of the request body and the |
translations | Array of objects An array of translation objects that contain content for any multilingual fields of the banner. |
{- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
}
bannerCode required | string Example: bannerCode Banner code |
expand | string Enum: "translations" "visibilities" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
}
bannerCode required | string Example: bannerCode Banner code |
group_id | integer The ID of the banner group this banner belongs to |
sort | integer A number that represents the banner's position in the banner group relative to other banners. |
code | string The banner's individual code. Set in the banner form's Codename field. |
title | string The banner's title. If present in both the root of the request body and the |
content | string The banner's text/HTML content. If present in both the root of the request body and the |
visible_from | string <date-time> The date when the banner becomes visible in the store. |
visible_to | string <date-time> The date when the banner is hidden. |
file | string The banner image. Enter only the filename of the image. The image file must reside in the store's file archive, and cannot be sent in the same request, with which you create or update a banner. The default path of the images is the files/tuotekuvat directory. |
link | string The banner link. If present in both the root of the request body and the |
translations | Array of objects An array of translation objects that contain content for any multilingual fields of the banner. |
{- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "group_id": 4,
- "sort": 1,
- "code": "new-discounts",
- "title": "New discounts for the summer",
- "content": "<p>We have some exciting stuff for you this summer!</p>",
- "visible_from": "2013-06-19T20:41:47+03:00",
- "visible_to": "2014-06-19T20:41:47+03:00",
- "file": "discounts.jpg",
- "link": "/campaigns/43",
- "translations": [
- {
- "language": "en",
- "title": "Fresh discounts just for this week",
- "content": "<p>We publish new discounts every week.</p>",
- "link": "/campaign/42"
}, - {
- "language": "fi",
- "title": "Uusia tarjouksia vain tälle viikolle.",
- "content": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "link": "/campaign/43"
}
]
}
}
expand | string Value: "translations" Comma-separated list of expandable sub-resources. |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Bernard's",
- "description": "Quality clothes from Bernard's",
- "seo_title": "Document title",
- "seo_page_title": "Page title",
- "seo_meta_description": "Meta description",
- "translations": [
- {
- "language": "en",
- "description": "<p>We publish new discounts every week.</p>",
- "seo_title": "Bernard's products",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Finest Bernard's products"
}, - {
- "language": "fi",
- "description": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "seo_title": "Bernard's-tuotteet",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Hienoimmat Bernard's-tuotteet"
}
], - "visibilities": [
- {
- "version_id": 4,
- "is_visible": false
}, - {
- "version_id": 3,
- "is_visible": true
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
name required | string The brand name |
description | string The brand description. Accepts HTML content. |
seo_title | string (seo_title) The SEO document title. Shown, for example, in Google search results as the title. |
seo_page_title | string (seo_page_title) The SEO page title. Shown on the page, in place of the usual page title, if set. |
seo_meta_description | string (seo_meta_description) The SEO meta description. Shown, for example, in Google search results as the page description. |
translations | Array of objects An array of translation objects that contain content for any multilingual fields of the brand. |
{- "name": "Bernard's",
- "description": "Quality clothes from Bernard's",
- "seo_title": "Document title",
- "seo_page_title": "Page title",
- "seo_meta_description": "Meta description",
- "translations": [
- {
- "language": "en",
- "description": "<p>We publish new discounts every week.</p>",
- "seo_title": "Bernard's products",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Finest Bernard's products"
}, - {
- "language": "fi",
- "description": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "seo_title": "Bernard's-tuotteet",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Hienoimmat Bernard's-tuotteet"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Bernard's",
- "description": "Quality clothes from Bernard's",
- "seo_title": "Document title",
- "seo_page_title": "Page title",
- "seo_meta_description": "Meta description",
- "translations": [
- {
- "language": "en",
- "description": "<p>We publish new discounts every week.</p>",
- "seo_title": "Bernard's products",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Finest Bernard's products"
}, - {
- "language": "fi",
- "description": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "seo_title": "Bernard's-tuotteet",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Hienoimmat Bernard's-tuotteet"
}
], - "visibilities": [
- {
- "version_id": 4,
- "is_visible": false
}, - {
- "version_id": 3,
- "is_visible": true
}
]
}
}
brandID required | integer >= 1 Unique identifier for the brand |
expand | string Value: "translations" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Bernard's",
- "description": "Quality clothes from Bernard's",
- "seo_title": "Document title",
- "seo_page_title": "Page title",
- "seo_meta_description": "Meta description",
- "translations": [
- {
- "language": "en",
- "description": "<p>We publish new discounts every week.</p>",
- "seo_title": "Bernard's products",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Finest Bernard's products"
}, - {
- "language": "fi",
- "description": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "seo_title": "Bernard's-tuotteet",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Hienoimmat Bernard's-tuotteet"
}
], - "visibilities": [
- {
- "version_id": 4,
- "is_visible": false
}, - {
- "version_id": 3,
- "is_visible": true
}
]
}
}
brandID required | integer >= 1 Unique identifier for the brand |
name | string The brand name |
description | string The brand description. Accepts HTML content. |
seo_title | string (seo_title) The SEO document title. Shown, for example, in Google search results as the title. |
seo_page_title | string (seo_page_title) The SEO page title. Shown on the page, in place of the usual page title, if set. |
seo_meta_description | string (seo_meta_description) The SEO meta description. Shown, for example, in Google search results as the page description. |
translations | Array of objects An array of translation objects that contain content for any multilingual fields of the brand. |
{- "name": "Bernard's",
- "description": "Quality clothes from Bernard's",
- "seo_title": "Document title",
- "seo_page_title": "Page title",
- "seo_meta_description": "Meta description",
- "translations": [
- {
- "language": "en",
- "description": "<p>We publish new discounts every week.</p>",
- "seo_title": "Bernard's products",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Finest Bernard's products"
}, - {
- "language": "fi",
- "description": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "seo_title": "Bernard's-tuotteet",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Hienoimmat Bernard's-tuotteet"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Bernard's",
- "description": "Quality clothes from Bernard's",
- "seo_title": "Document title",
- "seo_page_title": "Page title",
- "seo_meta_description": "Meta description",
- "translations": [
- {
- "language": "en",
- "description": "<p>We publish new discounts every week.</p>",
- "seo_title": "Bernard's products",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Finest Bernard's products"
}, - {
- "language": "fi",
- "description": "<p>Julkaisemme uusia tarjouksia joka viikko.</p>",
- "seo_title": "Bernard's-tuotteet",
- "seo_page_title": "Bernard's",
- "seo_meta_description": "Hienoimmat Bernard's-tuotteet"
}
], - "visibilities": [
- {
- "version_id": 4,
- "is_visible": false
}, - {
- "version_id": 3,
- "is_visible": true
}
]
}
}
expand | string Enum: "prices" "translations" "visibilities" Comma-separated list of expandable sub-resources. |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "published": true,
- "conditions": {
- "time": {
- "from": null,
- "to": "2020-11-30T23:59:59+02:00"
}, - "code": "ALE123",
- "customers": {
- "group_ids": [
- 1,
- 4,
- 5
]
}
}, - "discounts": {
- "products": {
- "enabled": true,
- "quantity_discounts": true
}, - "free_shipping": {
- "enabled": true
}, - "discount_row": {
- "enabled": false
}
}, - "page": {
- "description": "<p>All product -25 % for the summer. Act now, don't miss out!</p>",
- "enabled": true,
- "image": "image.png",
- "link": "/category/6",
- "pinned": false,
- "template": "campaign/campaign-alternative"
}, - "translations": [
- {
- "language": "fi",
- "name": "Macbook-ale",
- "description": "Kaikki Macbookit nyt -50 %",
- "seo_title": "Päivin putiikin Macbook-ale",
- "seo_page_title": "Kaikki Macbookit nyt -50 %",
- "seo_meta_description": "Osta Macbook puoleen hintaan"
}, - {
- "language": "en",
- "name": "Macbook sale!",
- "description": "All Macbooks now at -50 %",
- "seo_title": "Macbook sale at Päivi's boutique",
- "seo_page_title": "All Macbooks now -50 %",
- "seo_meta_description": "Get your Macbook at half the price."
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
campaignID required | integer >= 1 Unique identifier for the campaign |
expand | string Enum: "prices" "translations" "visibilities" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "published": true,
- "conditions": {
- "time": {
- "from": null,
- "to": "2020-11-30T23:59:59+02:00"
}, - "code": "ALE123",
- "customers": {
- "group_ids": [
- 1,
- 4,
- 5
]
}
}, - "discounts": {
- "products": {
- "enabled": true,
- "quantity_discounts": true
}, - "free_shipping": {
- "enabled": true
}, - "discount_row": {
- "enabled": false
}
}, - "page": {
- "description": "<p>All product -25 % for the summer. Act now, don't miss out!</p>",
- "enabled": true,
- "image": "image.png",
- "link": "/category/6",
- "pinned": false,
- "template": "campaign/campaign-alternative"
}, - "translations": [
- {
- "language": "fi",
- "name": "Macbook-ale",
- "description": "Kaikki Macbookit nyt -50 %",
- "seo_title": "Päivin putiikin Macbook-ale",
- "seo_page_title": "Kaikki Macbookit nyt -50 %",
- "seo_meta_description": "Osta Macbook puoleen hintaan"
}, - {
- "language": "en",
- "name": "Macbook sale!",
- "description": "All Macbooks now at -50 %",
- "seo_title": "Macbook sale at Päivi's boutique",
- "seo_page_title": "All Macbooks now -50 %",
- "seo_meta_description": "Get your Macbook at half the price."
}
]
}
}
campaignID required | integer >= 1 Unique identifier for the campaign |
published | boolean Determines whether the campaign is published or not. With the value |
translations | Array of objects |
{- "published": true,
- "translations": [
- {
- "language": "fi",
- "name": "Macbook-ale",
- "description": "Kaikki Macbookit nyt -50 %",
- "seo_title": "Päivin putiikin Macbook-ale",
- "seo_page_title": "Kaikki Macbookit nyt -50 %",
- "seo_meta_description": "Osta Macbook puoleen hintaan"
}, - {
- "language": "en",
- "name": "Macbook sale!",
- "description": "All Macbooks now at -50 %",
- "seo_title": "Macbook sale at Päivi's boutique",
- "seo_page_title": "All Macbooks now -50 %",
- "seo_meta_description": "Get your Macbook at half the price."
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "published": true,
- "conditions": {
- "time": {
- "from": null,
- "to": "2020-11-30T23:59:59+02:00"
}, - "code": "ALE123",
- "customers": {
- "group_ids": [
- 1,
- 4,
- 5
]
}
}, - "discounts": {
- "products": {
- "enabled": true,
- "quantity_discounts": true
}, - "free_shipping": {
- "enabled": true
}, - "discount_row": {
- "enabled": false
}
}, - "page": {
- "description": "<p>All product -25 % for the summer. Act now, don't miss out!</p>",
- "enabled": true,
- "image": "image.png",
- "link": "/category/6",
- "pinned": false,
- "template": "campaign/campaign-alternative"
}, - "translations": [
- {
- "language": "fi",
- "name": "Macbook-ale",
- "description": "Kaikki Macbookit nyt -50 %",
- "seo_title": "Päivin putiikin Macbook-ale",
- "seo_page_title": "Kaikki Macbookit nyt -50 %",
- "seo_meta_description": "Osta Macbook puoleen hintaan"
}, - {
- "language": "en",
- "name": "Macbook sale!",
- "description": "All Macbooks now at -50 %",
- "seo_title": "Macbook sale at Päivi's boutique",
- "seo_page_title": "All Macbooks now -50 %",
- "seo_meta_description": "Get your Macbook at half the price."
}
]
}
}
Update the discount prices of campaign products.
NOTE: The product discount row is identified by using a combination of the resource id and quantity.
For example
product_id
, variation_id
and quantity
,product_id
, download_id
and quantity
.campaignID required | integer >= 1 Unique identifier for the campaign |
[- {
- "product_id": 4,
- "price": 39.99
}, - {
- "product_id": 5,
- "variation_id": 3,
- "price": 39.99,
- "order_limit": 3
}, - {
- "product_id": 4,
- "download_id": 2,
- "quantity": 3,
- "price": 39.99
}
]
{- "data": [
- [
- {
- "product_id": 4,
- "price": 39.99
}, - {
- "product_id": 5,
- "variation_id": 3,
- "price": 39.99,
- "order_limit": 3
}, - {
- "product_id": 4,
- "download_id": 2,
- "quantity": 3,
- "price": 39.99
}
]
]
}
Remove a product discount from a campaign.
NOTE: The product discount row is identified by using a combination of the resource id and quantity.
For example
product_id
, variation_id
and quantity
,product_id
, download_id
and quantity
.campaignID required | integer >= 1 Unique identifier for the campaign |
{- "error": "<error message>",
- "description": "<error description>"
}
expand | string Enum: "translations" "visibilities" Comma-separated list of expandable sub-resources. |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
parent_id required | integer The parent category's ID |
parent_sort | integer An integer that determines the category's location relative to the parent category's other child categories |
name required | string You can provide the name of the category in either the main |
description | string The category description. |
default_template | string Enum: "category-front" "product-list" "homepage" The display type of the product category |
external_id | integer The category's ID in an external system |
translations | Array of objects An array of translation objects, which contain content for any multilingual fields of the category. |
{- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
}
categoryID required | integer >= 1 Unique identifier for the category |
expand | string Enum: "translations" "visibilities" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
}
categoryID required | integer >= 1 Unique identifier for the category |
parent_id | integer The parent category's ID |
parent_sort | integer An integer that determines the category's location relative to the parent category's other child categories |
name | string You can provide the name of the category in either the main |
description | string The category description. |
default_template | string Enum: "category-front" "product-list" "homepage" The display type of the product category |
external_id | integer The category's ID in an external system |
translations | Array of objects An array of translation objects, which contain content for any multilingual fields of the category. |
{- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
}
externalID required | string The category's external ID |
expand | string Enum: "translations" "visibilities" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
}
externalID required | string The category's external ID |
parent_id | integer The parent category's ID |
parent_sort | integer An integer that determines the category's location relative to the parent category's other child categories |
name | string You can provide the name of the category in either the main |
description | string The category description. |
default_template | string Enum: "category-front" "product-list" "homepage" The display type of the product category |
external_id | integer The category's ID in an external system |
translations | Array of objects An array of translation objects, which contain content for any multilingual fields of the category. |
{- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
}
categoryID required | integer >= 1 Unique identifier for the category |
expand | string Enum: "translations" "visibilities" Comma-separated list of expandable sub-resources. |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "parent_id": 1,
- "parent_sort": 4,
- "name": "Pants",
- "description": "<p>Category description content</p>",
- "default_template": "category-front",
- "external_id": 56,
- "translations": [
- {
- "language": "fi",
- "name": "Kengät",
- "description": "Hyviä kenkiä"
}, - {
- "language": "en",
- "name": "Shoes",
- "description": "Nice shoes"
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
categoryID required | integer >= 1 Unique identifier for the category |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "version_id": 1,
- "is_visible": false
}
]
}
categoryID required | integer >= 1 Unique identifier for the category |
version_id | integer >= 1 ID of the version, where the item's visibility is toggled. |
is_visible | boolean Determines whether the item is visible in the designated version. |
[- {
- "version_id": 1,
- "is_visible": false
}
]
{- "data": [
- {
- "version_id": 1,
- "is_visible": false
}
]
}
categoryID required | integer >= 1 Unique identifier for the category |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "category_id": 3,
- "category_sort": 1,
- "product_id": 2,
- "product_sort": 4
}
]
}
expand | string Enum: "translations" "customer_links" Comma-separated list of expandable sub-resources. |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Jälleenmyyjät",
- "customer_links": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 234,
- "customer_group_id": 1
}, - {
- "id": 2,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 456,
- "customer_group_id": 1
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
name required | string Name of the customer group |
{- "name": "Jälleenmyyjät"
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Jälleenmyyjät",
- "customer_links": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 234,
- "customer_group_id": 1
}, - {
- "id": 2,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 456,
- "customer_group_id": 1
}
]
}
}
customerGroupID required | integer >= 1 Unique identifier for the customer group |
expand | string Enum: "translations" "customer_links" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Jälleenmyyjät",
- "customer_links": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 234,
- "customer_group_id": 1
}, - {
- "id": 2,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 456,
- "customer_group_id": 1
}
]
}
}
customerGroupID required | integer >= 1 Unique identifier for the customer group |
name | string Name of the customer group |
{- "name": "Jälleenmyyjät"
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Jälleenmyyjät",
- "customer_links": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 234,
- "customer_group_id": 1
}, - {
- "id": 2,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 456,
- "customer_group_id": 1
}
]
}
}
customerGroupID required | integer >= 1 Unique identifier for the customer group |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "customer_id": 354,
- "customer_group_id": 3
}
]
}
customerGroupID required | integer >= 1 Unique identifier for the customer group |
customer_id | integer >= 1 The customer ID |
{- "customer_id": 354
}
{- "data": {
- "customer_id": 354,
- "customer_group_id": 3
}
}
customerGroupID required | integer >= 1 Unique identifier for the customer group |
customerID required | integer >= 1 Unique identifier for the customer |
{- "error": "<error message>",
- "description": "<error description>"
}
expand | string Value: "customer_groups" Comma-separated list of expandable sub-resources. |
created_at-from | string <date-time> Example: created_at-from=2017-06-14T20:45:52+03:00 Retrieve customer accounts that have been created on or after the specified date and time. You can provide the datetime value in any of these three following formats:
|
created_at-to | string <date-time> Example: created_at-to=2017-06-14T20:45:52+03:00 Retrieve customer accounts that have been created on or before the specified date and time. You can provide the datetime value in any of these three following formats:
|
updated_at-from | string <date-time> Example: updated_at-from=2017-06-14T20:45:52 Retrieve customer accounts that have been updated on or after the specified date and time. You can provide the datetime value in any of these three following formats:
|
updated_at-to | string <date-time> Example: updated_at-to=2017-06-14T20:45:52 Retrieve customer accounts that have been updated on or before the specified date and time. You can provide the datetime value in any of these three following formats:
|
last_login_at-from | string <date-time> Example: last_login_at-from=2017-06-14T20:45:52 Retrieve customer accounts that have most recently logged in on or after the specified date and time. You can provide the datetime value in any of these three following formats:
|
last_login_at-to | string <date-time> Example: last_login_at-to=2017-06-14T20:45:52 Retrieve customer accounts that have most recently logged in on or before the specified date and time. You can provide the datetime value in any of these three following formats:
|
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "version_id": 4,
- "language": "fi",
- "email_subscription": true,
- "einvoice_address": {
- "edi_code": "003721315706",
- "operator_code": "E204503"
}, - "sms_subscription": false,
- "customer_groups": [
- {
- "id": 3,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Resellers"
}, - {
- "id": 5,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Gift card recipients"
}
]
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
first_name required | string The customer's first name |
last_name required | string The customer's last name |
login_allowed required | boolean
|
company | string The customer's company |
vat_code | string The customer's VAT code.
Required if |
street_address required | string Street address |
postal_code required | string Postal code |
city required | string City |
country required | string Country code |
phone | string Phone number |
email required | string Email address |
language | string The customer's language code |
{- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "language": "fi"
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "version_id": 4,
- "language": "fi",
- "email_subscription": true,
- "einvoice_address": {
- "edi_code": "003721315706",
- "operator_code": "E204503"
}, - "sms_subscription": false,
- "customer_groups": [
- {
- "id": 3,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Resellers"
}, - {
- "id": 5,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Gift card recipients"
}
]
}
}
customerID required | integer >= 1 Unique identifier for the customer |
expand | string Value: "customer_groups" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "version_id": 4,
- "language": "fi",
- "email_subscription": true,
- "einvoice_address": {
- "edi_code": "003721315706",
- "operator_code": "E204503"
}, - "sms_subscription": false,
- "customer_groups": [
- {
- "id": 3,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Resellers"
}, - {
- "id": 5,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Gift card recipients"
}
]
}
}
customerID required | integer >= 1 Unique identifier for the customer |
first_name | string The customer's first name |
last_name | string The customer's last name |
login_allowed | boolean
|
company | string The customer's company |
vat_code | string The customer's VAT code.
Required if |
street_address | string Street address |
postal_code | string Postal code |
city | string City |
country | string Country code |
phone | string Phone number |
string Email address | |
language | string The customer's language code |
{- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "language": "fi"
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "version_id": 4,
- "language": "fi",
- "email_subscription": true,
- "einvoice_address": {
- "edi_code": "003721315706",
- "operator_code": "E204503"
}, - "sms_subscription": false,
- "customer_groups": [
- {
- "id": 3,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Resellers"
}, - {
- "id": 5,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Gift card recipients"
}
]
}
}
customerID required | integer >= 1 Unique identifier for the customer |
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "customer_id": 2,
- "primary": false,
- "email": "mail@example.com",
- "company": "Pulse247 Oy",
- "first_name": "Example",
- "last_name": "Customer",
- "street_address": "Kaivokatu 12",
- "street_name": "Moussaouistraat",
- "street_number": "22",
- "house_extension": "b",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "fi",
- "phone": "+3585012312312"
}
]
}
email required | string The customer's email address |
expand | string Value: "customer_groups" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "version_id": 4,
- "language": "fi",
- "email_subscription": true,
- "einvoice_address": {
- "edi_code": "003721315706",
- "operator_code": "E204503"
}, - "sms_subscription": false,
- "customer_groups": [
- {
- "id": 3,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Resellers"
}, - {
- "id": 5,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Gift card recipients"
}
]
}
}
externalID required | string The customer's ID in an external system |
expand | string Value: "customer_groups" Comma-separated list of expandable sub-resources. |
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "first_name": "Example",
- "last_name": "Customer",
- "login_allowed": true,
- "company": "Example Company Inc.",
- "vat_code": "1234567-6",
- "street_address": "Example street 2",
- "postal_code": "00100",
- "city": "Helsinki",
- "country": "FI",
- "phone": "05012312312",
- "email": "mail@domain.fi",
- "version_id": 4,
- "language": "fi",
- "email_subscription": true,
- "einvoice_address": {
- "edi_code": "003721315706",
- "operator_code": "E204503"
}, - "sms_subscription": false,
- "customer_groups": [
- {
- "id": 3,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Resellers"
}, - {
- "id": 5,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "name": "Gift card recipients"
}
]
}
}
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
updated_at-from | string <date-time> Example: updated_at-from=2017-06-14T20:45:52 Filters subscribers whose details have been updated at or after the specified date and time.' You can provide the datetime value in any of these three following formats:
|
updated_at-to | string <date-time> Example: updated_at-to=2017-06-14T20:45:52 Filters subscribers whose details have been updated at or before the specified date and time.' You can provide the datetime value in any of these three following formats:
|
{- "data": [
- {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "email": "mail@example.com",
- "version_id": 5,
- "language": "fi",
- "country": "fi",
- "subscribed_at": "2016-02-25T11:31:39+02:00",
- "unsubscribed_at": "2016-02-25T11:31:39+02:00"
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
email required | string The subscriber's email address |
{- "email": "mail@example.com"
}
{- "data": {
- "id": 1,
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "email": "mail@example.com",
- "version_id": 5,
- "language": "fi",
- "country": "fi",
- "subscribed_at": "2016-02-25T11:31:39+02:00",
- "unsubscribed_at": "2016-02-25T11:31:39+02:00"
}
}
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc Determines the sorting of the response list. |
{- "data": [
- {
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "expires_at": "2021-10-20",
- "code": "DTGZRVGGYPS2YMNC",
- "notes": "Example content",
- "balance": 50
}
], - "meta": {
- "page": 1,
- "page_size": 100,
- "page_count": 3,
- "item_count": 300
}
}
If the gift card code is not provided in the POST body, a code will be automatically generated and included in the response.
expires_at | string <date> The expiry date of the gift card. Must be in the future. The gift card will expire at 0:00 am. on the given date. |
code | string The gift card code |
notes | string Internal notes for the gift card |
balance | number The gift card balance in euros |
{- "expires_at": "2021-10-20",
- "code": "DTGZRVGGYPS2YMNC",
- "notes": "Example content",
- "balance": 50
}
{- "data": {
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "expires_at": "2021-10-20",
- "code": "DTGZRVGGYPS2YMNC",
- "notes": "Example content",
- "balance": 50
}
}
giftCardCode required | string Unique gift card code The gift card code is automatically generated, when creating a gift card. |
{- "data": {
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "expires_at": "2021-10-20",
- "code": "DTGZRVGGYPS2YMNC",
- "notes": "Example content",
- "balance": 50
}
}
giftCardCode required | string Unique gift card code The gift card code is automatically generated, when creating a gift card. |
expires_at | string <date> The expiry date of the gift card. Must be in the future. The gift card will expire at 0:00 am. on the given date. |
code | string The gift card code |
notes | string Internal notes for the gift card |
balance | number The gift card balance in euros |
{- "expires_at": "2021-10-20",
- "code": "DTGZRVGGYPS2YMNC",
- "notes": "Example content",
- "balance": 50
}
{- "data": {
- "created_at": "2013-06-19T20:41:47+03:00",
- "updated_at": "2013-06-19T20:41:47+03:00",
- "expires_at": "2021-10-20",
- "code": "DTGZRVGGYPS2YMNC",
- "notes": "Example content",
- "balance": 50
}
}
page_size | integer Default: 50 Example: page_size=50 Determines the number of items included on a page of the response list. |
page | integer Default: 0 Example: page=2 Determines the page that is retrieved (used only in conjunction with |
sort | string Default: "id-asc" Enum: "id-asc" "id-desc" Example: sort=id-asc |