Create a new address for a customer.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| addressType | true | Shipping or billing. | ||
| name | true | The name of the address | ||
| streetAndNumber | true | |||
| zip | true | The ZIP code. | ||
| city | true | |||
| state | false | |||
| country | false | |||
| telephone | true | |||
| false | ||||
| attentionFirstName | false | |||
| attentionLastName | false | |||
| language | false | Sets the language of the address. Format is ISO 639-1 | ||
| externalApp | false | Identification of the app that is performing the request. |
Get a token by authenticating with a valid username and password.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| _username | true | The username of your Velleman Account. | ||
| _password | true |
Adds a product to the cart.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| productId | true | The id of the product that you want to add. | ||
| qty | true | The quantity that you want to add to the cart. | ||
| remark | false | A remark that you want to add to the orderline. | ||
| yourProductReference | false | Use this parameter to provide your own name to a product. This name can be used later to look up products. | ||
| requestedDeliveryDate | false | The date that you would like to have the product delivered. |
Updates an item from the cart.
| Name | Requirement | Type | Description |
|---|---|---|---|
| itemId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| qty | true | The quantity that you want to add to the cart. | ||
| remark | false | A remark that you want to add to the orderline. | ||
| yourProductReference | false | Use this parameter to provide your own name to a product. This name can be used later to look up products. | ||
| requestedDeliveryDate | false | The date that you would like to have the product delivered. |
Get all products in a category.
| Name | Requirement | Type | Description |
|---|---|---|---|
| categoryId |
| Name | Information | ||
|---|---|---|---|
| language |
|
Create a new order from all items currently in the shopping cart.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| reference | false | A name for this order. If none is provided then the current date is used in format 'Ymd'. e.g. 20170802. | ||
| remark | false | |||
| addressId | false | The id of the receiver address for this order. If not provided your default address is used. | ||
| externalApp | false | Identification of the app that is performing the request. | ||
| fromCurrentCart | false | Creates an order from the website shopping cart. | ||
| quoteId | false | Creates an order from quote {quoteId}. |
Get a product by its id.
| Name | Requirement | Type | Description |
|---|---|---|---|
| productId |
| Name | Information | ||
|---|---|---|---|
| language |
|
||
| details |
|
||
| raw_bbcode |
|
Get features of a product.
| Name | Requirement | Type | Description |
|---|---|---|---|
| productId |
| Name | Information | ||
|---|---|---|---|
| language |
|
||
| raw_bbcode |
|
Get files associated with a product.
| Name | Requirement | Type | Description |
|---|---|---|---|
| productId |
| Name | Information | ||
|---|---|---|---|
| language |
|
Get unit and total price for a given quantity.
| Name | Requirement | Type | Description |
|---|---|---|---|
| productId | |||
| quantity |
| Name | Information | ||
|---|---|---|---|
| deliveryDate |
|
Get specifications of a product.
| Name | Requirement | Type | Description |
|---|---|---|---|
| productId |
| Name | Information | ||
|---|---|---|---|
| language |
|
||
| raw_bbcode |
|
Get all products have become available in the last <
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| language |
|
||||||
| days_back |
|
Get products that became obsolete in the last <
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| language |
|
||||||
| days_back |
|
Get a product ID by an identifier of varying types. Supported identifiers are - the Velleman SKU -
| Name | Information | ||
|---|---|---|---|
| identifier |
|
Get products that will be available in <
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| language |
|
||||||
| days_ahead |
|
Get all products of a promotion.
| Name | Requirement | Type | Description |
|---|---|---|---|
| promotionId |
| Name | Information | ||
|---|---|---|---|
| language |
|
Documentation auto-generated on Sun, 07 Dec 25 18:42:50 +0100