Download Specification
This API specification is available for download as an Open API 2.0 YAML file:
Limitations
API Specification
/shops/{shopName}/customers/{shopCustomerNumber}
GET: Get GDPR relevant customer data
Description
Returns GDPR relevant customer data for a given shopCustomerNumber and shopName.
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | shopCustomerNumber | string | | | Required | The customer number of the shop |
in path | shopName | string | | | Required | The shop name |
Response
200 - OK
Customer application/json
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|
WWW-Authenticate | |
403 - Forbidden
404 - Not Found
Customer application/json
{"creationDate":
string
Format: date-time
| Example: 2018-02-27T09:15:37.562+02:00
"customerType":
string
Example: b2c
"dayOfBirth":
string
Format: date
| Example: 1992-01-10
"firstName":
string
Example: Bob
"hasNewsletter":
boolean
Example: false
"isActive":
boolean
Example: true
"isNewCustomer":
boolean
Example: true
"lastName":
string
Example: Buyer
"gender":
string
Example: male
"shopCustomerNo":
string
Deprecated: will be replaced by shopCustomerNumber in a future version. | Example: BB002
"shopCustomerNumber":
string
Example: BB002
"email":
string
Example: b.buyer@bbcompany.de
"bankAccounts":
array
An array of CustomerBankAccount
objects.
[
CustomerBankAccount
:
Represents a bank account of a customer.{
}
]
"addresses":
array
An array of Address
objects.
[
Address
:
Represents an address of a customer.{
"firstName":
string
The first name of the address owner. | Example: Bob
"lastName":
string
The last name of the address owner. | Example: Buyer
"title":
string
The title of the address owner. | Example: Dr.
"street":
string
The street of the address of the address owner. | Example: Musterstraße
"houseNumber":
string
The house number of the address of the address owner. | Example: 5
"addressAddition1":
string
The first address addition of the address of the address owner. | Example: 3. OG
"addressAddition2":
string
The second address addition of the address of the address owner. | Example: Terasse
"addressAddition3":
string
The third address addition of the address of the address owner.
"addressAddition4":
string
The fourth address addition of the address of the address owner.
"addressType":
string
The type of the address. | Example: Shipping address
"postCode":
string
The postal code of the address of the address owner. | Example: 10178
"city":
string
The city of the address of the address owner. | Example: Berlin
"district":
string
The distrct of the address of the address owner.
"country":
string
The country of the address of the address owner. | Example: Germany
"email":
string
The email address of the address owner. | Example: b.buyer@bbcompany.de
"fax":
string
The fax number of the address owner.
"mobilePhone":
string
The mobile phone number of the address owner.
"phone1":
string
The first phone number of the address owner.
"phone2":
string
The second phone number of the address owner.
"isContainerFreightStation":
boolean
"gender":
string
The gender of the address owner. | Example: male
"salutation":
string
The salutation of the address owner. | Example: Mr.
}
]
"orders":
array
An array of CustomerOrder
objects.
[
CustomerOrder
:
Represents an order of a customer.{
"id":
integer
The order identifier. | Format: int32
| Example: 10000
"shopOrderNo":
string
The order number as used by the shop. Deprecated: will be replaced by shopOrderNumber in a future version. | Example: 20180303_123
"shopOrderNumber":
string
The order number as used by the shop. | Example: 20180303_123
"shopCustomerOrderNo":
string
The order number as given from the customer of the shop. Deprecated: will be replaced by shopCustomerOrderNumber in a future version. | Example: 20180303_123
"shopCustomerOrderNumber":
string
The order number as given from the customer of the shop. | Example: 20180303_123
"paymentProviderOrderNo":
string
The order number as used by the payment service provider. Deprecated: will be replaced by paymentProviderOrderNumber in a future version. | Example: 20180303_123
"paymentProviderOrderNumber":
string
The order number as used by the payment service provider. | Example: 20180303_123
"shopOrderCreationDate":
string
The date when the order was created at the shop. | Format: date-time
| Example: 2018-02-27T09:15:37.562+02:00
"paymentMethod":
string
The name of the payment method. | Example: credit card
"shopSubTotalGross":
number
The gross amount of the order positions (discounted order amount without charges) as given from the shop. | Format: double
| Example: 11.9
"shopSubTotalNet":
number
The net amount of the order positions (discounted order amount without charges) as given from the shop. | Format: double
| Example: 10
"shopTotalGross":
number
The gross amount of the order as given from the shop. | Format: double
| Example: 11.9
"shopTotalNet":
number
The net amount of the order as given from the shop. | Format: double
| Example: 10
"carrier":
string
The name of the carrier. | Example: DHL
"shopSubTotalGrossDiscounted":
number
The discounted gross amount of the order positions (discounted order amount without charges) as given from the shop. | Format: double
| Example: 11.9
"shopSubTotalNetDiscounted":
number
The discounted net amount of the order positions (discounted order amount without charges) as given from the shop. | Format: double
| Example: 10
"recalculatedShopSubTotalGrossDiscounted":
number
The discounted gross amount of the order positions (discounted order amount without charges) recalculated on cancellations. | Format: double
| Example: 11.9
"recalculatedShopSubTotalNetDiscounted":
number
The discounted net amount of the order positions (discounted order amount without charges) recalculated on cancellations. | Format: double
| Example: 10
"currency":
string
The currency the amounts are listed in. | Example: EUR
"orderPositions":
array
An array of CustomerOrderPosition
objects.
[
CustomerOrderPosition
:
Represents an order position of an order of a customer.{
"shopArticleNo":
string
Deprecated: will be replaced by shopArticleNumber in a future version. | Example: 100-0001
"shopArticleNumber":
string
Example: 100-0001
"shopArticleName":
string
Example: test_product_1
"orderPosNo":
integer
Deprecated: will be replaced by orderPosNumber in a future version. | Format: int32
| Example: 1
"orderPosNumber":
integer
Format: int32
| Example: 1
"quantityCanceled":
integer
Format: int32
| Example: 2
"quantityOrdered":
integer
Format: int32
| Example: 10
"quantityReturned":
integer
Format: int32
| Example: 2
"returnDate":
string
Format: date-time
| Example: 2018-02-27T09:15:37.562+02:00
"shopItemGross":
number
Format: double
"shopItemNet":
number
Format: double
"shopItemTax":
number
Format: double
"shopPosGross":
number
Format: double
"shopPosNet":
number
Format: double
"shopPosTax":
number
Format: double
"shopPosNetDiscounted":
number
Format: double
"shopPosGrossDiscounted":
number
Format: double
"shopItemNetDiscounted":
number
Format: double
"shopItemGrossDiscounted":
number
Format: double
"quantityRefunded":
integer
Format: int32
"shippingAddress":
object
A Address
object. Represents an address of a customer.
{
"firstName":
string
The first name of the address owner. | Example: Bob
"lastName":
string
The last name of the address owner. | Example: Buyer
"title":
string
The title of the address owner. | Example: Dr.
"street":
string
The street of the address of the address owner. | Example: Musterstraße
"houseNumber":
string
The house number of the address of the address owner. | Example: 5
"addressAddition1":
string
The first address addition of the address of the address owner. | Example: 3. OG
"addressAddition2":
string
The second address addition of the address of the address owner. | Example: Terasse
"addressAddition3":
string
The third address addition of the address of the address owner.
"addressAddition4":
string
The fourth address addition of the address of the address owner.
"addressType":
string
The type of the address. | Example: Shipping address
"postCode":
string
The postal code of the address of the address owner. | Example: 10178
"city":
string
The city of the address of the address owner. | Example: Berlin
"district":
string
The distrct of the address of the address owner.
"country":
string
The country of the address of the address owner. | Example: Germany
"email":
string
The email address of the address owner. | Example: b.buyer@bbcompany.de
"fax":
string
The fax number of the address owner.
"mobilePhone":
string
The mobile phone number of the address owner.
"phone1":
string
The first phone number of the address owner.
"phone2":
string
The second phone number of the address owner.
"isContainerFreightStation":
boolean
"gender":
string
The gender of the address owner. | Example: male
"salutation":
string
The salutation of the address owner. | Example: Mr.
}
}
]
}
]
"invoiceAndCreditNotes":
array
An array of CustomerInvoiceAndCreditNote
objects.
[
CustomerInvoiceAndCreditNote
:
Represents an invoice of a customer.{
"type":
string
Represents the type ("invoice" or "creditnote") | Example: creditnote
"relatedShopOrderNos":
array
An array of string
literals. The list of shop order numbers of the related orders. Deprecated: will be replaced by relatedShopOrderNumbers in a future version. | Example: [20180303_123, 20180303_124]
"relatedShopOrderNumbers":
array
An array of string
literals. The list of shop order numbers of the related orders. | Example: [20180303_123, 20180303_124]
"invoiceNo":
string
The number of the invoice or credit note. Deprecated: will be replaced by invoiceNumber in a future version. | Example: 2018-000002
"invoiceNumber":
string
The number of the invoice or credit note. | Example: 2018-000002
"referenceInvoiceNo":
string
The original invoice related to this invoice in case of invoice updates. Deprecated: will be replaced by referenceInvoiceNumber in a future version. | Example: 2018-000001
"referenceInvoiceNumber":
string
The original invoice related to this invoice in case of invoice updates. | Example: 2018-000001
"invoicingDate":
string
Date when the invioce creation was finished. | Format: date-time
| Example: 2018-02-27T09:15:37.562+02:00
"currency":
string
The currency the invoice prices are listed in. | Example: EUR
"paymentMethod":
string
The name of the payment method. | Example: credit card
"paymentDueDate":
string
Date when the invoice have to be registered as payed (payment deadline) at site of the business owner. | Format: date-time
| Example: 2018-02-27T09:15:37.562+02:00
"invoicePositions":
array
An array of CustomerInvoicePosition
objects.
[
CustomerInvoicePosition
:
Represents an invoice position of an invoice of a customer.{
"shopOrderNo":
string
Deprecated: will be replaced by shopOrderNumber in a future version. | Example: 20180303_123
"shopOrderNumber":
string
Example: 20180303_123
"shopArticleNo":
string
Deprecated: will be replaced by shopArticleNumber in a future version. | Example: 100-0001
"shopArticleNumber":
string
Example: 100-0001
"quantity":
integer
Format: int32
| Example: 10
"salesItemNet":
number
Format: double
| Example: 1
"salesItemGross":
number
Format: double
| Example: 1.19
"chargeNet":
number
Format: double
| Example: 0
"chargeGross":
number
Format: double
| Example: 0
}
]
}
]
"customerBalances":
array
An array of CustomerBalance
objects.
[
CustomerBalance
:
Represents a customer balance.{
"currency":
string
The currency the amounts are listed in. | Example: EUR
"openInvoiceAmount":
number
Format: double
| Example: -154.7
"openInvoiceAmountCalculationDate":
string
Format: date-time
| Example: 2018-02-27T09:15:37.562+02:00
"bookedCreditSum":
number
Format: double
| Example: 0
"bookedDebitSum":
number
Format: double
| Example: 0
"chargedCreditSum":
number
Format: double
| Example: 0
"chargedDebitSum":
number
Format: double
| Example: 0
"chargedOpenSum":
number
Format: double
| Example: 0
"invoicingCreditSum":
number
Format: double
| Example: 0
"invoicingDebitSum":
number
Format: double
| Example: -154.7
"negativeBookedOpenSum":
number
Format: double
| Example: 154.7
"positiveBookedOpenSum":
number
Format: double
| Example: 0
}
]
}The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.