GET v1/Shops/{shopId}/CustomerContracts?active={active}&pageSize={pageSize}&pageNumber={pageNumber}

Get a list with all available CustomerContracts, for the given shop.

Request Information

URI Parameters

Name	Description	Type	Additional information
shopId	The id of the shop.	integer	Required.
active	Return only Contract which are active or not.	boolean	Is Optional. Default value is True.
pageSize	The max number of items returned. Default this value is 100.	integer	Is Optional. Default value is 100.
pageNumber	The page to return. Default page 1 will be returned.	integer	Is Optional. Default value is 1.

Body Parameters

None.

Response Information

Resource Description

A list of the CustomerContractBasicInfo objects.

Collection of CustomerContractBase

Name	Type	Additional information
Id	integer	Required
ContractCode	string	Max length: 50
Name	string	Required Max length: 100
CustomerId	integer	Required
StartDate	date	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "ContractCode": "sample string 2",
    "Name": "sample string 3",
    "CustomerId": 4,
    "StartDate": "2026-01-11T16:16:25.3186248+01:00"
  },
  {
    "Id": 1,
    "ContractCode": "sample string 2",
    "Name": "sample string 3",
    "CustomerId": 4,
    "StartDate": "2026-01-11T16:16:25.3186248+01:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerContractBase xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerContractBase>
    <Id>1</Id>
    <ContractCode>sample string 2</ContractCode>
    <Name>sample string 3</Name>
    <CustomerId>4</CustomerId>
    <StartDate>2026-01-11T16:16:25.3186248+01:00</StartDate>
  </CustomerContractBase>
  <CustomerContractBase>
    <Id>1</Id>
    <ContractCode>sample string 2</ContractCode>
    <Name>sample string 3</Name>
    <CustomerId>4</CustomerId>
    <StartDate>2026-01-11T16:16:25.3186248+01:00</StartDate>
  </CustomerContractBase>
</ArrayOfCustomerContractBase>