Returns sites from the input stage
This endpoint has been deprecated and may be removed in future versions of the API.
Returns page of sites from the input stage.
Query Parameters
- page string
Default value:
0
Number of page to get results from
- size string
Possible values:
<= 100
Default value:
10
Size of each page
- 200
- 400
The requested page of sites
- application/json
- Schema
- Example (from schema)
Schema
- totalElements int64
Total number of all results in all pages
- totalPages int32
Total number pages
- page int32
Current page number
- contentSize int32
Number of results in the page
content object[]
Collection of results in the page
nameParts string[]The list of name parts of the site to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the owner chooses.
states object[]
The list of the (temporary) states of the site.
description stringvalidFrom date-timeThe date from which the state is valid.
validTo date-timeThe date until the state is valid.
type stringPossible values: [
ACTIVE
,INACTIVE
]One of the state types: active, inactive.
roles string[]Possible values: [
SUPPLIER
,CUSTOMER
,ONE_TIME_SUPPLIER
,ONE_TIME_CUSTOMER
]Roles this business partner takes in relation to the sharing member.
mainAddress object
In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA.
nameParts string[]The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses.
states object[]
The list of (temporary) states of the address.
description stringvalidFrom date-timeThe date from which the state is valid.
validTo date-timeThe date until the state is valid.
type stringPossible values: [
ACTIVE
,INACTIVE
]One of the state types: active, inactive.
identifiers object[]
The list of identifiers of the address.
value stringThe value of the identifier like "0847976000005".
type stringThe type of the identifier.
physicalPostalAddress object
A physical postal address describes the physical location of an office, warehouse, gate, etc.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
administrativeAreaLevel2 stringThe name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.
administrativeAreaLevel3 stringThe name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
district stringThe name of the district of the physical postal address which divides the city in several smaller areas.
street object
The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway
namePrefix stringThe street related information, which is usually printed before the official street name on an address label.
additionalNamePrefix stringThe additional street related information, which is usually printed before the official street name on an address label.
name stringThe name of the street.
nameSuffix stringThe street related information, which is usually printed after the official street name on an address label.
additionalNameSuffix stringThe additional street related information, which is usually printed after the official street name on an address label.
houseNumber stringThe number representing the exact location of a building within the street.
houseNumberSupplement stringmilestone stringThe number representing the exact location of an addressed object within a street without house numbers, such as within long roads.
direction stringThe cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.
companyPostalCode stringThe company postal code of the physical postal address, which is sometimes required for large companies.
industrialZone stringThe industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.
building stringThe alphanumeric identifier of the building addressed by the physical postal address.
floor stringThe number of a floor in the building addressed by the physical postal address, synonym: level.
door stringThe number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.
alternativePostalAddress object
An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
deliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]One of the alternative postal address types: P.O. box, private bag, boite postale.
deliveryServiceQualifier stringThe qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
deliveryServiceNumber stringThe number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
roles string[]Possible values: [
SUPPLIER
,CUSTOMER
,ONE_TIME_SUPPLIER
,ONE_TIME_CUSTOMER
]Roles this business partner takes in relation to the sharing member.
confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfBusinessPartners int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32externalId stringThe identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
legalEntityExternalId stringThe identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the legal entity, that owns the address.
siteExternalId stringThe identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the site, that the address belongs to.
externalId stringThe identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
legalEntityExternalId stringThe identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner owning the site.
{
"totalElements": 0,
"totalPages": 0,
"page": 0,
"contentSize": 0,
"content": [
{
"nameParts": [
"string"
],
"states": [
{
"description": "string",
"validFrom": "2024-02-22",
"validTo": "2024-02-22",
"type": "ACTIVE"
}
],
"roles": [
"SUPPLIER"
],
"mainAddress": {
"nameParts": [
"string"
],
"states": [
{
"description": "string",
"validFrom": "2024-02-22",
"validTo": "2024-02-22",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"namePrefix": "string",
"additionalNamePrefix": "string",
"name": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"roles": [
"SUPPLIER"
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfBusinessPartners": 0,
"lastConfidenceCheckAt": "2024-02-22",
"nextConfidenceCheckAt": "2024-02-22",
"confidenceLevel": 0
},
"externalId": "string",
"legalEntityExternalId": "string",
"siteExternalId": "string"
},
"externalId": "string",
"legalEntityExternalId": "string"
}
]
}
On malformed pagination request