POST api/ClientProducts

Method to add a new client Product to the system

Request Information

URI Parameters

None.

URI Example

api/ClientProducts

Body Parameters

The clientProduct data

Oresto.API.Models.POST.ClientProducts.ClientProduct
NameDescriptionTypeAdditional information
ClientNumber

The number of the client defined by the wholesaler

string

Required

Max length: 50

IsExlusive

Is the product exclusive for this client?

boolean

Required

SalesPriceList

The list sales price

decimal number

Range: inclusive between 0 and 1E+16

SalesPriceListPromo

The list sales price during a promotion

decimal number

Range: inclusive between 0 and 1E+16

WholesalerArticleNumber

Article code for the product defined by the wholesaler

string

Primary key field

Required

Max length: 50

Request Formats

application/json, text/json

Sample:
{
  "WholesalerArticleNumber": "sample string 1",
  "ClientNumber": "sample string 2",
  "SalesPriceList": 1.0,
  "SalesPriceListPromo": 1.0,
  "IsExlusive": true
}

application/xml, text/xml

Sample:
<ClientProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.ClientProducts">
  <ClientNumber>sample string 2</ClientNumber>
  <IsExlusive>true</IsExlusive>
  <SalesPriceList>1</SalesPriceList>
  <SalesPriceListPromo>1</SalesPriceListPromo>
  <WholesalerArticleNumber>sample string 1</WholesalerArticleNumber>
</ClientProduct>

application/x-www-form-urlencoded

Sample:
WholesalerArticleNumber=value&ClientNumber=value&SalesPriceList=value&SalesPriceListPromo=value&IsExlusive=value

Response Information

Resource Description

A wrapper class with information about the new entity

Oresto.API.Models.POST.ClientProducts.ClientProductData
NameDescriptionTypeAdditional information
Errors

Possible errors that were experienced when processing the request

Collection of string

None.

ModelStateErrors

Possible model errors that were experienced when validating the data

Collection of Oresto.API.Models.Shared.ModelStateError

None.

RequestInformation

Additional information about the request

Oresto.API.Models.Shared.RequestInformation

None.

Response Formats

application/json, text/json

Sample:
{
  "RequestInformation": {
    "RequestDuration": 1,
    "WholesalerId": 2,
    "UserId": 3
  },
  "ModelStateErrors": [
    {
      "Key": "sample string 1",
      "Message": "sample string 2",
      "Exception": "sample string 3"
    },
    {
      "Key": "sample string 1",
      "Message": "sample string 2",
      "Exception": "sample string 3"
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ClientProductData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.ClientProducts">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <ModelStateErrors xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
    <ModelStateError>
      <Exception>sample string 3</Exception>
      <Key>sample string 1</Key>
      <Message>sample string 2</Message>
    </ModelStateError>
    <ModelStateError>
      <Exception>sample string 3</Exception>
      <Key>sample string 1</Key>
      <Message>sample string 2</Message>
    </ModelStateError>
  </ModelStateErrors>
  <RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
    <RequestDuration>1</RequestDuration>
    <UserId>3</UserId>
    <WholesalerId>2</WholesalerId>
  </RequestInformation>
</ClientProductData>