POST Customers/Customer

Retrieves an existing 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.Web.Models.Common.Customer">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.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.
ShippingContact		CustomerContact	None.
BillingContact		CustomerContact	None.
Language		Language	None.
Type		CustomerType	None.
PaymentMeans		PaymentMeans	None.
VatIdentifier		string	None.
BacCode		string	None.
BusinessName		string	None.
Contacts		Collection of CustomerContact	None.
InvoiceRequired		boolean	None.
IsEquivalenceSurcharged		boolean	None.
Points	Points balance	integer	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.
QuickPayments	QuickPayments allowed by the customer	Collection of QuickPayment	None.
NewsletterSubscriberID		integer	None.
Name		string	Required String length: inclusive between 0 and 100
Surnames		string	String length: inclusive between 0 and 100
Gender		Gender	None.
DateOfBirth		date	None.
FullName		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "ShippingContact": {
    "ID": 1,
    "IsIntraCommunitaryOperator": true,
    "Alias": "sample string 3",
    "Name": "sample string 4",
    "Surnames": "sample string 5",
    "VatIdentifier": "sample string 6",
    "Email": "sample string 7",
    "WebURL": "sample string 8",
    "Phone": "sample string 9",
    "Addressee": "sample string 10",
    "Street": "sample string 11",
    "PostalCode": "sample string 12",
    "Place": {
      "ID": 1,
      "Name": "sample string 2",
      "PostalCode": "sample string 3",
      "LocalityID": 1
    },
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "Code": "sample string 3"
    },
    "RegionCode": "sample string 13"
  },
  "BillingContact": {
    "ID": 1,
    "IsIntraCommunitaryOperator": true,
    "Alias": "sample string 3",
    "Name": "sample string 4",
    "Surnames": "sample string 5",
    "VatIdentifier": "sample string 6",
    "Email": "sample string 7",
    "WebURL": "sample string 8",
    "Phone": "sample string 9",
    "Addressee": "sample string 10",
    "Street": "sample string 11",
    "PostalCode": "sample string 12",
    "Place": {
      "ID": 1,
      "Name": "sample string 2",
      "PostalCode": "sample string 3",
      "LocalityID": 1
    },
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "Code": "sample string 3"
    },
    "RegionCode": "sample string 13"
  },
  "Language": {
    "ID": 1,
    "Name": "sample string 2",
    "Code": "sample string 3"
  },
  "Type": {
    "ID": 1,
    "Name": "sample string 2",
    "TaxDisplay": true,
    "InvoiceRequired": true
  },
  "PaymentMeans": {
    "ID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Base": 4.0,
    "Amount": 5.0,
    "Percent": 6.0,
    "QuickPayment": true,
    "ProcessorSettings": {
      "ID": 1,
      "Name": "sample string 2",
      "Settings": null,
      "Form": "sample string 3"
    }
  },
  "VatIdentifier": "sample string 2",
  "BacCode": "sample string 3",
  "BusinessName": "sample string 4",
  "Contacts": [
    {
      "ID": 1,
      "IsIntraCommunitaryOperator": true,
      "Alias": "sample string 3",
      "Name": "sample string 4",
      "Surnames": "sample string 5",
      "VatIdentifier": "sample string 6",
      "Email": "sample string 7",
      "WebURL": "sample string 8",
      "Phone": "sample string 9",
      "Addressee": "sample string 10",
      "Street": "sample string 11",
      "PostalCode": "sample string 12",
      "Place": {
        "ID": 1,
        "Name": "sample string 2",
        "PostalCode": "sample string 3",
        "LocalityID": 1
      },
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "Code": "sample string 3"
      },
      "RegionCode": "sample string 13"
    },
    {
      "ID": 1,
      "IsIntraCommunitaryOperator": true,
      "Alias": "sample string 3",
      "Name": "sample string 4",
      "Surnames": "sample string 5",
      "VatIdentifier": "sample string 6",
      "Email": "sample string 7",
      "WebURL": "sample string 8",
      "Phone": "sample string 9",
      "Addressee": "sample string 10",
      "Street": "sample string 11",
      "PostalCode": "sample string 12",
      "Place": {
        "ID": 1,
        "Name": "sample string 2",
        "PostalCode": "sample string 3",
        "LocalityID": 1
      },
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "Code": "sample string 3"
      },
      "RegionCode": "sample string 13"
    }
  ],
  "InvoiceRequired": true,
  "IsEquivalenceSurcharged": true,
  "Points": 7,
  "BusinessID": 1,
  "ShippingBusinessContactID": 1,
  "QuickPayments": [
    {
      "ID": 1,
      "PaymentMeansID": 2
    },
    {
      "ID": 1,
      "PaymentMeansID": 2
    }
  ],
  "NewsletterSubscriberID": 1,
  "Name": "sample string 8",
  "Surnames": "sample string 9",
  "Gender": 1,
  "DateOfBirth": "2024-11-18T16:22:03.2764409+01:00",
  "FullName": "sample string 8 sample string 9"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.