POST Customers/Customer

Retrieves a Customer

Request Information

URI Parameters

None.

Body Parameters

CustomerRequest

Name	Type	Additional information
ID	string	Required String length: inclusive between 0 and 128
Lang	string	None.
StoreID	integer	None.

Name

Description

Type

Additional information

string

Required

String length: inclusive between 0 and 128

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<CustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Customer">
  <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>sample string 1</ID>
</CustomerRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Customer

Name	Description	Type	Additional information
ID		string	None.
Email	Customer User's email	string	None.
Phone		string	None.
Created		date	None.
Modified		date	None.
Disabled		date	None.
ExternalID	ID of Customer in the external database (Use only for data sync)	string	None.
ShippingContactID		integer	None.
BillingContactID		integer	None.
LanguageID		integer	None.
TypeID		integer	None.
PaymentMeansID		integer	None.
TariffID		integer	None.
VatIdentifier		string	None.
BacCode	bac (business activity code. Epígrafe iae in spain)	string	None.
BusinessName		string	None.
InvoiceRequired		boolean	None.
ExcludeTaxes		boolean	None.
NewsletterSubscriberID	NewsletterSubscriber ID	integer	None.
IsEquivalenceSurcharged	The equivalence surcharge is a special VAT regime compulsory for retail sellers that don’t make any kind of transformation to the products they sell. That is for the self-employed sellers that sell to the final client. It’s applied both to physical people that register as self-employed to communities of property. The supplier of the seller is to include the equivalence surcharge of their invoices, separated from the VAT, and consider both amount as VAT charged on their VAT statements.	boolean	None.
BusinessID	A customer related to a business uses BusinessContacts as Shipping Contacts	integer	None.
ShippingBusinessContactID	Default BusinessContact for this customer used for Shipping	integer	None.
Points	Points balance	integer	None.
Name		string	None.
Surnames		string	None.
Gender		Gender	None.
DateOfBirth		date	None.
FullName		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "Email": "sample string 2",
  "Phone": "sample string 3",
  "Created": "2025-12-06T05:40:29.0999845+01:00",
  "Modified": "2025-12-06T05:40:29.0999845+01:00",
  "Disabled": "2025-12-06T05:40:29.0999845+01:00",
  "ExternalID": "sample string 6",
  "ShippingContactID": 1,
  "BillingContactID": 1,
  "LanguageID": 7,
  "TypeID": 8,
  "PaymentMeansID": 9,
  "TariffID": 10,
  "VatIdentifier": "sample string 11",
  "BacCode": "sample string 12",
  "BusinessName": "sample string 13",
  "InvoiceRequired": true,
  "ExcludeTaxes": true,
  "NewsletterSubscriberID": 1,
  "IsEquivalenceSurcharged": true,
  "BusinessID": 1,
  "ShippingBusinessContactID": 1,
  "Points": 17,
  "Name": "sample string 18",
  "Surnames": "sample string 19",
  "Gender": 1,
  "DateOfBirth": "2025-12-06T05:40:29.0999845+01:00",
  "FullName": "sample string 18 sample string 19"
}

application/xml, text/xml

Sample:

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer">
  <DateOfBirth xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">2025-12-06T05:40:29.0999845+01:00</DateOfBirth>
  <Gender xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">Male</Gender>
  <Name xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 18</Name>
  <Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 19</Surnames>
  <BacCode>sample string 12</BacCode>
  <BillingContactID>1</BillingContactID>
  <BusinessID>1</BusinessID>
  <BusinessName>sample string 13</BusinessName>
  <Created>2025-12-06T05:40:29.0999845+01:00</Created>
  <Disabled>2025-12-06T05:40:29.0999845+01:00</Disabled>
  <Email>sample string 2</Email>
  <ExcludeTaxes>true</ExcludeTaxes>
  <ExternalID>sample string 6</ExternalID>
  <ID>sample string 1</ID>
  <InvoiceRequired>true</InvoiceRequired>
  <IsEquivalenceSurcharged>true</IsEquivalenceSurcharged>
  <LanguageID>7</LanguageID>
  <Modified>2025-12-06T05:40:29.0999845+01:00</Modified>
  <NewsletterSubscriberID>1</NewsletterSubscriberID>
  <PaymentMeansID>9</PaymentMeansID>
  <Phone>sample string 3</Phone>
  <Points>17</Points>
  <ShippingBusinessContactID>1</ShippingBusinessContactID>
  <ShippingContactID>1</ShippingContactID>
  <TariffID>10</TariffID>
  <TypeID>8</TypeID>
  <VatIdentifier>sample string 11</VatIdentifier>
</Customer>