GetCustomerProducts

Description

The database of the shop does not contain the customer's own articlenumbers but if this REST API function is implemented the shop can facilitate the use of the customer's own product numbers.

This function can be implemented if the ERP system supports the storage of the customer own article numbers for the articles in the ERP.

REST API:

URL: /Shoxl/v1/GetCustomerProducts Method: POST

Changes in ShoxlRestApiSwagger_v16

• A new field "context" is introduced in the request body. When configured this object contains key value pairs (e.g. divisionCode).

Request body:

GetCustomerProductsRequest{

accountNumber	string required	Account number of the customer that is logged in into the shop.
productNumbers	[string] required	List of product numbers as they exist in the shop database.
context	object	A generic object designed to hold key-value pairs for the purpose of providing customer-specific fields.

}

Example:

{
  "accountNumber": "128",
  "productNumbers": [ "90001", "80001", "70001" ],
  "context": {
    "divisionCode": "string"
  }  
}

Response body:

GetCustomerProductsResult{

Parameter	Type	Description
errorCode	string nullable: true	An error code returned by the ERP system
errorDescription	string nullable: true	The error description related to the error code returned by the ERP system
customerProducts	[CustomerProduct]	List of CustomerProduct objects

}

CustomerProduct{

Parameter	Type	Description
productNumber	string nullable: true	Product number of the ERP system (that is also used in the shop)
ownProductNumber	string nullable: true	The customer's own productnumber

}

Example:

{
  "errorCode": "string",
  "errorDescription": "string",
  "customerProducts": [
    {
      "productNumber": "90001",
      "ownProductNumber": "4321"
    }.
    {
      "productNumber": "70001",
      "ownProductNumber": "123456789"
    }
  ],
}