Intro
This documentation provides information about the PCKasse API developed by Easy Step AS.
Default definitions:
- The API uses HTTP Methods
GET, POST, PUT and DELETE
- Every request must include
Content-Type: application/json among its headers.
GET requests receive data via URL. E.g.: https://stageapi.easy-step.no/api/login?username=jane&password=doe
POST, PUT and DELETE requests receive data as JSON attached to the request body.
- Parameters are case sensitive, please follow their names accordingly.
- Strings must be encoded in
UTF-8, especially when having multibyte characters.
- Some methods support double encoded URL characters, e.g:
%25C3%2598 -> %C3%98 -> Ø (Latin Capital Letter O with Stroke), although is NOT recommended sending any strings like this. See URL Encoding Reference.
- All requests return
HTTP 200 status with a JSON object with the following format:
Return Codes
Short description on how to read this API's return codes
HTTP Status Codes
This API uses HTTP Status Codes to communicate back to the source and inform the real status of each operation. Although the "real" request status should always be HTTP 200, the specific requests may return an assorted types of codes with a short text explaining the situation.
All the examples on this page are based on successful operations returning code 200, but you might get codes on the 400s/500s if something goes wrong.
The following example shows the real return if the Login method is called with a GET request:
Error handling
We use 600 to 699 code range to return specific API errors. This creates a good standard and hopefully makes it easier to understand the operation flow.
The relevant codes for this API follows:
- 602 - Missing Parameters
- 603 - Expired Authorization Hash
POST Login
POST https://stageapi.easy-step.no/api/login
Request authorization hash to access the API
| Parameter |
Type |
Required |
Default |
Description |
| Username |
String |
true |
null |
Username |
| Password |
String |
true |
null |
Password |
| Temp |
boolean |
false |
false |
Whether the hash is temporary or not. A temporary hash does not invalidate others for the same account and lasts for 30 minutes |
Return Values
GET Customer
GET https://stageapi.easy-step.no/api/customers
Get customers by telephone and/or number and/or name. Returns an array with CustomerInfo objects limited to 100 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| Telephone |
int |
false |
null |
Customer's phone number (numbers only, field Telephone). |
| Phone |
int |
false |
null |
Customer's phone number (numbers only, field Phone). |
| Name |
String |
false |
null |
Customer's name. |
| CustomerNo |
int |
false |
null |
Customer's number (non-zero). |
| CompanyNo |
String |
false |
null |
Customer's company number. |
| Status |
int |
false |
null |
Customer's status. |
| Offset |
Int |
false |
null |
API returns the first 100 results. Passing Offset=1, it returns the 101st to 200th; Offset=2, it returns the 201st to 300th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
Return Values
GET Customer Groups
GET https://stageapi.easy-step.no/api/customers_groups
Get customer groups. Returns an array with groups info limited to 100 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| CustomerGroupID |
int |
false |
null |
The customer group ID in PCK |
| Name |
String |
false |
null |
Customer group name (or part of a name) |
| CustomerGroupNo |
int |
false |
null |
Customer group number |
Return Values
GET Customer History
GET https://stageapi.easy-step.no/api/customers_history
Get orders from a specific CustomerNo. Can be filtered by OrderDate between the defined period of OrderDateTimeFrom and OrderDateTimeUntil. Returns an array with order info limited to 100 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| CustomerNo |
int |
true |
null |
Customer's number (non-zero). |
| OrderDateTimeFrom |
DateTime |
false |
null |
Starting order date. Format: Y-m-d H:i:s |
| OrderDateTimeUntil |
DateTime |
false |
null |
Ending order date. Format: Y-m-d H:i:s |
Return Values
POST Customer
POST https://stageapi.easy-step.no/api/customers
Creates a customer
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| Telephone |
String |
true |
null |
Telephone |
| Name |
String |
true |
null |
Name |
| Phone |
String |
false |
null |
A secondary Telephone |
| MailingAddress |
String |
false |
null |
Street and number |
| MailingZip |
String |
false |
null |
Zipcode |
| MailingCity |
String |
false |
null |
City |
| Email |
String |
false |
null |
Email |
| Contact |
String |
false |
null |
Contact |
| Notes |
String |
false |
null |
Notes |
| CompanyNo |
String |
false |
null |
Company Number |
| Status |
int |
false |
0 |
Status |
| CustomerGroupNo |
int |
false |
null |
Customer group number |
| CustomerNo |
int |
false |
Last CustomerNo + 1 |
Customer number (non-zero) |
| PaymentTermID |
int |
false |
null |
PaymentTermID |
Return Values
PUT Customer
PUT https://stageapi.easy-step.no/api/customers
Updates a customer
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| CustomerID |
int |
true |
null |
The customer's ID in PCK |
| Telephone |
String |
false |
null |
Telephone |
| Phone |
String |
false |
null |
A secondary Telephone |
| Name |
String |
false |
null |
Name |
| MailingAddress |
String |
false |
null |
Street and number |
| MailingZip |
String |
false |
null |
Zipcode |
| MailingCity |
String |
false |
null |
City |
| Email |
String |
false |
null |
Email |
| Contact |
String |
false |
null |
Contact |
| Notes |
String |
false |
null |
Notes |
| CompanyNo |
String |
false |
null |
Company Number |
| Status |
int |
false |
null |
Status |
| CustomerGroupNo |
int |
false |
null |
Customer group number |
Return Values
GET Articles
GET https://stageapi.easy-step.no/api/articles
Get articles by ArticleNo, Name or Ean number. If none of these 3 parameters is provided, it returns the first 100 articles.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
false |
null |
ArticleNos separated by commas. Ex: 7768,7790,7834 |
| Name |
String |
false |
null |
Article Name (or part of a name) |
| EanNo |
String |
false |
null |
Ean number |
| Offset |
Int |
false |
null |
API returns the first 100 results. Passing Offset=1, it returns the 101st to 200th; Offset=2, it returns the 201st to 300th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
| ChangedAfterDate |
DateTime |
false |
null |
Filter for the last update date of article. Format: Y-m-d H:i:s |
| VisibleOnWeb |
Int |
false |
null |
Filter articles by VisibleOnWeb flag. It can be 1 or 0. |
Return Values
GET Articles With Extra
GET https://stageapi.easy-step.no/api/articles_extra
Get articles by ArticleNo, Name or Ean number with Extra Article info. If none of these 3 parameters is provided, it returns the first 100 articles.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
false |
null |
ArticleNos separated by commas. Ex: 7768,7790,7834 |
| Name |
String |
false |
null |
Article Name (or part of a name) |
| EanNo |
String |
false |
null |
Ean number |
| Offset |
Int |
false |
null |
API returns the first 100 results. Passing Offset=1, it returns the 101st to 200th; Offset=2, it returns the 201st to 300th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
| ChangedAfterDate |
DateTime |
false |
null |
Filter for the last update date of article. Format: Y-m-d H:i:s |
| VisibleOnWeb |
Int |
false |
null |
Filter articles by VisibleOnWeb flag. It can be 1 or 0. |
| OnlyWithExtra |
boolean |
false |
false |
If OnlyWithExtra is set to true, it only returns articles that have an Extra Article linked to it. |
Return Values
GET Price Tag
GET https://stageapi.easy-step.no/api/price_tag
Get articles by ArticleNo or Ean number with Extra Article info and some additional fields that are not present in normal GET articles method. If none of these 2 parameters is provided, it returns the first 100 articles.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
false |
null |
ArticleNos separated by commas. Ex: 7768,7790,7834 |
| EanNo |
String |
false |
null |
Ean number |
| Offset |
Int |
false |
null |
API returns the first 100 results. Passing Offset=1, it returns the 101st to 200th; Offset=2, it returns the 201st to 300th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
| ChangedAfterDate |
DateTime |
false |
null |
Filter for the last update date of article. Format: Y-m-d H:i:s |
| OnlyWithExtra |
boolean |
false |
false |
If OnlyWithExtra is set to true, it only returns articles that have an Extra Article linked to it. |
Return Values
POST Article
POST https://stageapi.easy-step.no/api/articles
Creates an article
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
true |
null |
ArticleNo |
| Name |
String |
true |
null |
Article's name |
| PostingGroupID |
int |
false |
null |
PostingGroupID. Use GET Posting Groups if needed |
| MainGroupID |
int |
false |
null |
MainGroupID. Use GET Groups if needed |
| SalesPrice |
float |
false |
null |
SalesPrice number using dot as decimal separator |
| AlternativePrice |
float |
false |
null |
AlternativePrice number using dot as decimal separator |
| PurchasePrice |
float |
false |
null |
PurchasePrice number using dot as decimal separator |
| EanNo |
String |
false |
null |
Ean Number |
Return Values
PUT Article
PUT https://stageapi.easy-step.no/api/articles
Updates an article based on ArticleNo
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
true |
null |
ArticleNo |
| Name |
String |
false |
null |
Name |
| SalesPrice |
float |
false |
null |
SalesPrice number using dot as decimal separator |
| AlternativePrice |
float |
false |
null |
AlternativePrice number using dot as decimal separator |
| PurchasePrice |
float |
false |
null |
PurchasePrice number using dot as decimal separator |
Return Values
GET Article Price By Customer
GET https://stageapi.easy-step.no/api/getArticlePriceByCustomer
Get the price for a specific article based on the customer it might be attached to. This is a special method thus not attached to the typical article method.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleID |
String |
true |
null |
ArticleIDs separated by commas. Ex: 7768,7790,7834 |
| Count |
String |
false |
null |
Articles quantities separated by commas. Ex: 3,10,1. If none is provided, it considers 1. |
| CustomerID |
String |
true |
null |
CustomerID |
Return Values
GET Article Price By Customer V2
GET https://stageapi.easy-step.no/api/getArticlePriceByCustomerV2
Get the price for a specific article based on the customer it might be attached to, using customer number and article number instead of IDs. If we have a special Offer Price available in the article, this will be returned as SpecialPricePeriod. This is a special method thus not attached to the typical article method.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
true |
null |
ArticleNos separated by commas. Ex: FIU 53264,FIU 53263,FIU 53265 |
| PositionNo |
String |
false |
null |
PositionNo separated by commas. Ex: 0,1,2 |
| Count |
String |
false |
null |
Articles quantities separated by commas. Ex: 3,10,1. If none is provided, it considers 1. |
| CustomerNo |
String |
false |
null |
CustomerNo (non-zero). If no customer number is defined, this method will get price that is not linked to customer. |
Return Values
GET Article Price By Customer V3
GET https://stageapi.easy-step.no/api/getArticlePriceByCustomerV3
Same as getArticlePriceByCustomerV2 but this method returns Extra Article info. Get the price for a specific article based on the customer it might be attached to, using customer number and article number instead of IDs. If we have a special Offer Price available in the article, this will be returned as SpecialPricePeriod. This is a special method thus not attached to the typical article method.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
true |
null |
ArticleNos separated by commas. Ex: FIU 53264,FIU 53263,FIU 53265 |
| PositionNo |
String |
false |
null |
PositionNo separated by commas. Ex: 0,1,2 |
| Count |
String |
false |
null |
Articles quantities separated by commas. Ex: 3,10,1. If none is provided, it considers 1. |
| CustomerNo |
String |
false |
null |
CustomerNo (non-zero). If no customer number is defined, this method will get price that is not linked to customer. |
Return Values
GET Article Stock
GET https://stageapi.easy-step.no/api/getArticleStock
Get the stock for the articles informed.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleID |
String |
false |
null |
ArticleIDs separated by commas. Ex: 7768,7790,7834. Max: 100 ArticleIDs. |
| EanNo |
String |
false |
null |
EanNos separated by commas. Ex: 7768,7790,7834. Max: 100 EanNos. |
| SoldAfterDateTime |
DateTime |
false |
null |
The stock starting by the provided date. Format: Y-m-d H:i:s |
| LocationID |
int |
false |
null |
The location. If not provide, will return from LocationID null. |
| Offset |
int |
false |
null |
If no ArticleID or EanNo is provided, API returns the first 100 results. Passing Offset=1, it returns the 101st to 200th; Offset=2, it returns the 201st to 300th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
Return Values
GET Article Stock V2
GET https://stageapi.easy-step.no/api/getArticleStockV2
Get the stock for the articles informed using ArticleNo instead of ArticleID
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
false |
null |
ArticleNos separated by commas. Ex: FIU 53264,FIU 53263,FIU 53265. Max: 100 ArticleNos. |
| EanNo |
String |
false |
null |
EanNos separated by commas. Ex: 7768,7790,7834. Max: 100 EanNos. |
| SoldAfterDateTime |
DateTime |
false |
null |
The stock starting by the provided date. Format: Y-m-d H:i:s |
| LocationID |
int |
false |
null |
The location. If not provide, will return from LocationID null. |
| Offset |
int |
false |
null |
If no ArticleID or EanNo is provided, API returns the first 100 results. Passing Offset=1, it returns the 101st to 200th; Offset=2, it returns the 201st to 300th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
Return Values
GET Order
GET https://stageapi.easy-step.no/api/orders
Get orders by OrderID.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderID |
int |
true |
null |
OrderID |
Return Values
POST Order
POST https://stageapi.easy-step.no/api/orders
Creates an order
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| CustomerID |
int |
true |
null |
CustomerID related to this order |
| OrderType |
int |
true |
null |
Flag describing the type of the order. Only allowed values are 0 or 2 |
| OrderLines |
Array |
true |
null |
Array with order lines with the following format:
|
| InvoiceNo |
int |
false |
null |
Invoice No |
| OrderDate |
DateTime |
false |
null |
Order Date on format 2020-06-21 13:44:21 |
| DeliveryDate |
DateTime |
false |
null |
Delivery Date on format 2020-06-21 13:44:21 |
| Reference |
String |
false |
null |
Additional reference |
| YourRef |
String |
false |
null |
Additional reference |
| DueDate |
DateTime |
false |
null |
Order due date on format 2020-06-21 13:44:21 |
| DepartmentID |
int |
false |
Setup.StandardDepartment |
Department ID. Use GET Departments if needed |
| Info |
String |
false |
null |
Additional info |
| PLInfo |
String |
false |
null |
Message to Employee |
| DeliveryName |
String |
false |
null |
Name of the delivery person. Maximum string length: 50 characters |
| DeliveryAddress1 |
String |
false |
null |
Street and number of the delivery address |
| DeliveryAddress2 |
String |
false |
null |
Additional address information |
| DeliveryZip |
String |
false |
null |
Address zip code |
| DeliveryCity |
String |
false |
null |
Address city |
| DeliveryPhone |
String |
false |
null |
Delivery person phone number |
| OrderTemplateID |
int |
false |
null |
OrderTemplateID |
| LocationID |
int |
false |
null |
LocationID |
Return Values
POST Order V2
POST https://stageapi.easy-step.no/api/orders_v2
Creates an order using CustomerNo and ArticleNo instead of CustomerID and ArticleID
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| CustomerNo |
int |
true |
null |
CustomerNo (non-zero) related to this order |
| OrderType |
int |
true |
null |
Flag describing the type of the order. Only allowed values are 0 or 2 |
| OrderLines |
Array |
true |
null |
Array with order lines with the following format:
|
| InvoiceNo |
int |
false |
null |
Invoice No |
| OrderDate |
DateTime |
false |
null |
Order Date on format 2020-06-21 13:44:21 |
| DeliveryDate |
DateTime |
false |
null |
Delivery Date on format 2020-06-21 13:44:21 |
| Reference |
String |
false |
null |
Additional reference |
| YourRef |
String |
false |
null |
Additional reference |
| DueDate |
DateTime |
false |
null |
Order due date on format 2020-06-21 13:44:21 |
| DepartmentID |
int |
false |
Setup.StandardDepartment |
Department ID. Use GET Departments if needed |
| Info |
String |
false |
null |
Additional info |
| PLInfo |
String |
false |
null |
Message to Employee |
| DeliveryName |
String |
false |
null |
Name of the delivery person. Maximum string length: 50 characters |
| DeliveryAddress1 |
String |
false |
null |
Street and number of the delivery address |
| DeliveryAddress2 |
String |
false |
null |
Additional address information |
| DeliveryZip |
String |
false |
null |
Address zip code |
| DeliveryCity |
String |
false |
null |
Address city |
| DeliveryPhone |
String |
false |
null |
Delivery person phone number |
| OrderTemplateID |
int |
false |
null |
OrderTemplateID |
| LocationID |
int |
false |
null |
LocationID |
| TransactionRef |
int |
false |
null |
TransactionRef for payment |
| AllDelivered |
int |
false |
null |
Default is 0. If order is delivered it should be 1 |
| ShippingMethodId |
int |
false |
null |
ShippingMethodId. Use GET Shipping Method if needed |
Return Values
PUT Order
PUT https://stageapi.easy-step.no/api/orders
Updates an order
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderID |
int |
true |
null |
OrderID |
| OrderType |
int |
false |
null |
Flag describing the type of the order |
| InvoiceNo |
int |
false |
null |
Invoice No |
| OrderDate |
DateTime |
false |
null |
Order Date on format 2020-06-21 13:44:21 |
| Reference |
String |
false |
null |
Additional reference |
| YourRef |
String |
false |
null |
Additional reference |
| DueDate |
DateTime |
false |
null |
Order due date on format 2020-06-21 13:44:21 |
| DepartmentID |
int |
false |
Setup.StandardDepartment |
Department ID. Use GET Departments if needed |
| Info |
String |
false |
null |
Additional info |
| PLInfo |
String |
false |
null |
Message to Employee |
| DeliveryName |
String |
false |
null |
Name of the delivery person. Maximum string length: 50 characters |
| DeliveryAddress1 |
String |
false |
null |
Street and number of the delivery address |
| DeliveryAddress2 |
String |
false |
null |
Additional address information |
| DeliveryZip |
String |
false |
null |
Address zip code |
| DeliveryCity |
String |
false |
null |
Address city |
| DeliveryPhone |
String |
false |
null |
Delivery person phone number |
| OrderTemplateID |
int |
false |
null |
OrderTemplateID |
| CustomerID |
int |
false |
null |
CustomerID |
| LocationID |
int |
false |
null |
LocationID |
Return Values
PUT Order V2
PUT https://stageapi.easy-step.no/api/orders_v2
Updates an order using CustomerNo instead of CustomerID
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderID |
int |
true |
null |
OrderID |
| OrderType |
int |
false |
null |
Flag describing the type of the order |
| InvoiceNo |
int |
false |
null |
Invoice No |
| OrderDate |
DateTime |
false |
null |
Order Date on format 2020-06-21 13:44:21 |
| Reference |
String |
false |
null |
Additional reference |
| YourRef |
String |
false |
null |
Additional reference |
| DueDate |
DateTime |
false |
null |
Order due date on format 2020-06-21 13:44:21 |
| DepartmentID |
int |
false |
Setup.StandardDepartment |
Department ID. Use GET Departments if needed |
| Info |
String |
false |
null |
Additional info |
| PLInfo |
String |
false |
null |
Message to Employee |
| DeliveryName |
String |
false |
null |
Name of the delivery person. Maximum string length: 50 characters |
| DeliveryAddress1 |
String |
false |
null |
Street and number of the delivery address |
| DeliveryAddress2 |
String |
false |
null |
Additional address information |
| DeliveryZip |
String |
false |
null |
Address zip code |
| DeliveryCity |
String |
false |
null |
Address city |
| DeliveryPhone |
String |
false |
null |
Delivery person phone number |
| OrderTemplateID |
int |
false |
null |
OrderTemplateID |
| CustomerNo |
int |
false |
null |
CustomerNo (non-zero) |
| LocationID |
int |
false |
null |
LocationID |
| TransactionRef |
int |
false |
null |
TransactionRef for payment |
| AllDelivered |
int |
false |
null |
Default is 0. If order is delivered it should be 1 |
| ShippingMethodId |
int |
false |
null |
ShippingMethodId. Use GET Shipping Method to get correct ID |
Return Values
DELETE Order
DELETE https://stageapi.easy-step.no/api/orders
Deletes an order and its orderlines. This operation can't be undone.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderID |
Array |
true |
null |
An array with the orders to be deleted:
|
Return Values
POST Orderline
POST https://stageapi.easy-step.no/api/orderlines
Creates an order line
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderID |
int |
true |
null |
OrderID related to this order |
| OrderLines |
Array |
true |
null |
An array with the order lines to be inserted:
|
Return Values
POST Orderline V2
POST https://stageapi.easy-step.no/api/orderlines_v2
Creates an order line using ArticleNo instead of ArticleID
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderID |
int |
true |
null |
OrderID related to this order |
| OrderLines |
Array |
true |
null |
An array with the order lines to be inserted:
|
Return Values
PUT OrderLine
PUT https://stageapi.easy-step.no/api/orderlines
Updates an orderline
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderLines |
Array |
true |
null |
An array with the order lines to be updated:
|
Return Values
PUT OrderLine V2
PUT https://stageapi.easy-step.no/api/orderlines_v2
Updates an orderline
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderLines |
Array |
true |
null |
An array with the order lines to be updated:
|
Return Values
DELETE OrderLine
DELETE https://stageapi.easy-step.no/api/orderlines
Deletes an orderline. This operation can't be undone.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderLines |
Array |
true |
null |
An array with the order lines to be deleted:
|
Return Values
GET Departments
GET https://stageapi.easy-step.no/api/departments
Get departments by name and/or department number. Returns an array limited to 100 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| Name |
String |
false |
null |
Name (or part of it) |
| DepartmentNo |
int |
false |
null |
DepartmentNo |
Return Values
GET Shipping Method
GET https://stageapi.easy-step.no/api/shippingmethod
Get Shipping Method. Returns an array limited to 100 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
Return Values
GET Order Shipments
GET https://stageapi.easy-step.no/api/ordershipments
Returns orders that have the shipment date between the defined period of InvoiceDateTimeFrom and InvoiceDateTimeUntil. Ordered by InvoiceDate ASC. Limited to 50 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| InvoiceDateTimeFrom |
DateTime |
true |
null |
Starting invoice date. Format: Y-m-d H:i:s |
| InvoiceDateTimeUntil |
DateTime |
false |
null |
Ending invoice date. Format: Y-m-d H:i:s |
| OrderType |
int |
false |
null |
Flag describing the type of the order |
| OrderTemplateID |
int |
false |
null |
OrderTemplateID |
| DepartmentID |
int |
false |
Setup.StandardDepartment |
DepartmentID. Use GET Departments if needed |
| LocationID |
int |
false |
null |
LocationID |
| OnlyPrivateCustomers |
boolean |
false |
false |
If OnlyPrivateCustomers is set to true, it only returns orders from private customers. |
| Offset |
Int |
false |
null |
API returns the first 50 results. Passing Offset=1, it returns the 51st to 100th; Offset=2, it returns the 101st to 150th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
Return Values
GET Park/Credit Orders
GET https://stageapi.easy-step.no/api/parkcreditorders
Returns orders with OrderType = 0 or 2, InvoiceNo 0 or null and that have OrderDate between the defined period of OrderDateTimeFrom and OrderDateTimeUntil. Ordered by OrderDate ASC. Limited to 50 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| OrderDateTimeFrom |
DateTime |
true |
null |
Starting order date. Format: Y-m-d H:i:s |
| OrderDateTimeUntil |
DateTime |
false |
null |
Ending order date. Format: Y-m-d H:i:s |
| OrderType |
int |
false |
0,2 |
Flag describing the type of the order. You can specify one of the two possible values if needed. |
| OrderTemplateID |
int |
false |
null |
OrderTemplateID |
| DepartmentID |
int |
false |
Setup.StandardDepartment |
DepartmentID. Use GET Departments if needed |
| LocationID |
int |
false |
null |
LocationID |
| Offset |
Int |
false |
null |
API returns the first 50 results. Passing Offset=1, it returns the 51st to 100th; Offset=2, it returns the 101st to 150th; and so on. Current Offset and AvailableOffsetRounds will be returned in extra payload. |
Return Values
GET Days Takings
GET https://stageapi.easy-step.no/api/daystakings
Returns Days Takings based on the date provided.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| PostingDate |
DateTime |
true |
null |
Starting posting date. Format: Y-m-d H:i:s |
| DepartmentId |
int |
false |
null |
DepartmentId |
Return Values
GET Special Price Period
GET https://stageapi.easy-step.no/api/specialpriceperiod
Returns ArticleNo, Offer Price and Vat based on the current date (now). This only returns articles that have current date between StartOfferPrice and StopOfferPrice. Limited to 1000 results.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| ArticleNo |
String |
false |
null |
ArticleNos separated by commas. Ex: FIU 53264,FIU 53263,FIU 53265 |
| Offset |
int |
false |
null |
API returns the first 1000 results. Passing Offset=1, it returns the 1001st to 2000th; Offset=2, it returns the 2001st to 3000th; and so on. |
Return Values
GET Employees
GET https://stageapi.easy-step.no/api/employees
Returns all employees limited to 100 results. Can be filtered by name.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| Name |
String |
false |
null |
Employee's name (or part of a name) |
Return Values
GET Groups
GET https://stageapi.easy-step.no/api/groups
Returns all MainGroups, ArticleGroup2s and ArticleGroup3s.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
Return Values
GET Posting Groups
GET https://stageapi.easy-step.no/api/postinggroups
Returns all Posting Groups and their Vat information.
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
Return Values
POST Main Group
POST https://stageapi.easy-step.no/api/groups
Creates a Main Group
| Parameter |
Type |
Required |
Default |
Description |
| Hash |
String |
true |
null |
Authentication hash returned by the POST Login method |
| DBName |
String |
true |
null |
Database name to get data from |
| Name |
String |
true |
null |
MainGroup's name |
| MainGroupNo |
int |
true |
null |
MainGroupNo |
Return Values