POST Providers
Retrieves all existing Providers.
Request Information
URI Parameters
None.
Body Parameters
GetProvidersRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Filter | Filter |
None. |
|
| Range | AdminFilterRange |
None. |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ProvidersView| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| Providers | Collection of Provider |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"Providers": [
{
"ID": 1,
"ExternalID": "sample string 2",
"Created": "2025-12-06T05:40:33.4878514+01:00",
"Disabled": "2025-12-06T05:40:33.4878514+01:00",
"Name": "sample string 4",
"PublicName": "sample string 5",
"ShippingTime": 6.0,
"IsIntraCommunitaryOperator": true,
"VatIdentifier": "sample string 8",
"PaymentMeansID": 9,
"Contact": {
"ID": 1,
"Alias": "sample string 2",
"Name": "sample string 3",
"Surnames": "sample string 4",
"VatIdentifier": "sample string 5",
"Email": "sample string 6",
"WebURL": "sample string 7",
"Phone": "sample string 8",
"Addressee": "sample string 9",
"Street": "sample string 10",
"PostalCode": "sample string 11",
"Place": {
"ID": 1,
"Name": "sample string 2",
"PostalCode": "sample string 3",
"LocalityID": 4
},
"Country": {
"ID": 1,
"Name": "sample string 2",
"Code": "sample string 3"
}
},
"Person": {
"ID": 1,
"Name": "sample string 2",
"Surnames": "sample string 3",
"Gender": 1,
"DateOfBirth": "2025-12-06T05:40:33.4878514+01:00"
},
"ProfitMargin": 10.0,
"Observations": "sample string 11"
},
{
"ID": 1,
"ExternalID": "sample string 2",
"Created": "2025-12-06T05:40:33.4878514+01:00",
"Disabled": "2025-12-06T05:40:33.4878514+01:00",
"Name": "sample string 4",
"PublicName": "sample string 5",
"ShippingTime": 6.0,
"IsIntraCommunitaryOperator": true,
"VatIdentifier": "sample string 8",
"PaymentMeansID": 9,
"Contact": {
"ID": 1,
"Alias": "sample string 2",
"Name": "sample string 3",
"Surnames": "sample string 4",
"VatIdentifier": "sample string 5",
"Email": "sample string 6",
"WebURL": "sample string 7",
"Phone": "sample string 8",
"Addressee": "sample string 9",
"Street": "sample string 10",
"PostalCode": "sample string 11",
"Place": {
"ID": 1,
"Name": "sample string 2",
"PostalCode": "sample string 3",
"LocalityID": 4
},
"Country": {
"ID": 1,
"Name": "sample string 2",
"Code": "sample string 3"
}
},
"Person": {
"ID": 1,
"Name": "sample string 2",
"Surnames": "sample string 3",
"Gender": 1,
"DateOfBirth": "2025-12-06T05:40:33.4878514+01:00"
},
"ProfitMargin": 10.0,
"Observations": "sample string 11"
}
]
}
application/xml, text/xml
Sample:
<ProvidersView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Provider">
<Providers>
<Provider>
<Contact>
<Addressee xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 9</Addressee>
<Country xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
<d5p1:Code>sample string 3</d5p1:Code>
<d5p1:ID>1</d5p1:ID>
<d5p1:Name>sample string 2</d5p1:Name>
</Country>
<Place xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
<d5p1:ID>1</d5p1:ID>
<d5p1:LocalityID>4</d5p1:LocalityID>
<d5p1:Name>sample string 2</d5p1:Name>
<d5p1:PostalCode>sample string 3</d5p1:PostalCode>
</Place>
<PostalCode xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 11</PostalCode>
<Street xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 10</Street>
<Email xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 6</Email>
<Phone xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 8</Phone>
<WebURL xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 7</WebURL>
<Alias xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 2</Alias>
<Name xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 3</Name>
<Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 4</Surnames>
<VatIdentifier xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 5</VatIdentifier>
<ID>1</ID>
</Contact>
<Created>2025-12-06T05:40:33.4878514+01:00</Created>
<Disabled>2025-12-06T05:40:33.4878514+01:00</Disabled>
<ExternalID>sample string 2</ExternalID>
<ID>1</ID>
<IsIntraCommunitaryOperator>true</IsIntraCommunitaryOperator>
<Name>sample string 4</Name>
<Observations>sample string 11</Observations>
<PaymentMeansID>9</PaymentMeansID>
<Person>
<DateOfBirth>2025-12-06T05:40:33.4878514+01:00</DateOfBirth>
<Gender>Male</Gender>
<ID>1</ID>
<Name>sample string 2</Name>
<Surnames>sample string 3</Surnames>
</Person>
<ProfitMargin>10</ProfitMargin>
<PublicName>sample string 5</PublicName>
<ShippingTime>6</ShippingTime>
<VatIdentifier>sample string 8</VatIdentifier>
</Provider>
<Provider>
<Contact>
<Addressee xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 9</Addressee>
<Country xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
<d5p1:Code>sample string 3</d5p1:Code>
<d5p1:ID>1</d5p1:ID>
<d5p1:Name>sample string 2</d5p1:Name>
</Country>
<Place xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
<d5p1:ID>1</d5p1:ID>
<d5p1:LocalityID>4</d5p1:LocalityID>
<d5p1:Name>sample string 2</d5p1:Name>
<d5p1:PostalCode>sample string 3</d5p1:PostalCode>
</Place>
<PostalCode xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 11</PostalCode>
<Street xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 10</Street>
<Email xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 6</Email>
<Phone xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 8</Phone>
<WebURL xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 7</WebURL>
<Alias xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 2</Alias>
<Name xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 3</Name>
<Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 4</Surnames>
<VatIdentifier xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 5</VatIdentifier>
<ID>1</ID>
</Contact>
<Created>2025-12-06T05:40:33.4878514+01:00</Created>
<Disabled>2025-12-06T05:40:33.4878514+01:00</Disabled>
<ExternalID>sample string 2</ExternalID>
<ID>1</ID>
<IsIntraCommunitaryOperator>true</IsIntraCommunitaryOperator>
<Name>sample string 4</Name>
<Observations>sample string 11</Observations>
<PaymentMeansID>9</PaymentMeansID>
<Person>
<DateOfBirth>2025-12-06T05:40:33.4878514+01:00</DateOfBirth>
<Gender>Male</Gender>
<ID>1</ID>
<Name>sample string 2</Name>
<Surnames>sample string 3</Surnames>
</Person>
<ProfitMargin>10</ProfitMargin>
<PublicName>sample string 5</PublicName>
<ShippingTime>6</ShippingTime>
<VatIdentifier>sample string 8</VatIdentifier>
</Provider>
</Providers>
<TotalCount>1</TotalCount>
</ProvidersView>