POST Providers/Provider

Retrieves an existing Provider.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<GetProviderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Provider">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <ID>1</ID>
</GetProviderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Provider

Name	Description	Type	Additional information
ID		integer	None.
ExternalID	ID of provider in the external database (Use only for data sync)	string	None.
Created		date	None.
Disabled		date	None.
Name		string	None.
PublicName		string	None.
ShippingTime		decimal number	None.
IsIntraCommunitaryOperator		boolean	None.
VatIdentifier		string	None.
PaymentMeansID		integer	None.
Contact		ProviderContact	None.
Person		ProviderContactPerson	None.
ProfitMargin		decimal number	None.
Observations		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "ExternalID": "sample string 2",
  "Created": "2025-12-06T09:18:01.9912418+01:00",
  "Disabled": "2025-12-06T09:18:01.9912418+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-06T09:18:01.9912418+01:00"
  },
  "ProfitMargin": 10.0,
  "Observations": "sample string 11"
}

application/xml, text/xml

Sample:

<Provider xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Provider">
  <Contact>
    <Addressee xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 9</Addressee>
    <Country xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
      <d3p1:Code>sample string 3</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Country>
    <Place xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
      <d3p1:ID>1</d3p1:ID>
      <d3p1:LocalityID>4</d3p1:LocalityID>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:PostalCode>sample string 3</d3p1: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-06T09:18:01.9912418+01:00</Created>
  <Disabled>2025-12-06T09:18:01.9912418+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-06T09:18:01.9912418+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>