IOM GDPR REST API (2.9.4.0)

Download OpenAPI specification:Download

The IOM GDPR REST API supports programmatic access to GDPR related objects.

Authentication

basicAuth

Basic Authentication

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

bearerAuth

JWT Bearer token

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

shop

API endpoints, that could be used by the shop.

Get GDPR relevant customer data

Returns GDPR relevant customer data for a given shopCustomerNumber and shopName.

Authorizations:

basicAuthbearerAuth

path Parameters

shopCustomerNumber required	string The customer number of the shop
shopName required	string The shop name

Responses

200

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

get /shops/{shopName}/customers/{shopCustomerNumber}

{protocol}://{domain}:{port}/rest/gdpr/shops/{shopName}/customers/{shopCustomerNumber}

Response samples

Content type

application/vnd.intershop.customer.v3+json

Copy

Expand all Collapse all


{"creationDate": "2020-04-16T16:12:24Z",
"customerType": "b2c",
"dayOfBirth": "2020-04-16",
"firstName": "Bob",
"hasNewsletter": false,
"isActive": true,
"isNewCustomer": true,
"lastName": "Buyer",
"gender": "male",
"shopCustomerNo": "BB002",
"shopCustomerNumber": "BB002",
"title": "string",
"email": "b.buyer@bbcompany.de",
"fax": "string",
"mobilePhone": "string",
"phone1": "string",
"phone2": "string",
"companyName": "string",
"bankAccounts": 
[
{"accountHolder": "string",
"accountNumber": "string",
"bankCode": "string",
"bankName": "string"
}
],
"addresses": 
[
{"firstName": "Bob",
"lastName": "Buyer",
"title": "Dr.",
"companyName": "string",
"street": "Musterstraße",
"houseNumber": "5",
"addressAddition1": "3. OG",
"addressAddition2": "Terasse",
"addressAddition3": "string",
"addressAddition4": "string",
"addressType": "Shipping address",
"postCode": "10178",
"city": "Berlin",
"district": "string",
"country": "Germany",
"email": "b.buyer@bbcompany.de",
"fax": "string",
"mobilePhone": "string",
"phone1": "string",
"phone2": "string",
"isContainerFreightStation": true,
"isDefault": true,
"gender": "male",
"salutation": "Mr.",
"poBox": "string",
"nightShipping": true
}
],
"orders": 
[
{"id": 10000,
"shopOrderNo": 20180303123,
"shopOrderNumber": 20180303123,
"shopCustomerOrderNo": 20180303123,
"shopCustomerOrderNumber": 20180303123,
"paymentProviderOrderNo": 20180303123,
"paymentProviderOrderNumber": 20180303123,
"shopOrderCreationDate": "2020-04-16T16:12:24Z",
"paymentMethod": "credit card",
"shopSubTotalGross": 11.9,
"shopSubTotalNet": 10,
"shopTotalGross": 11.9,
"shopTotalNet": 10,
"carrier": "DHL",
"shopSubTotalGrossDiscounted": 11.9,
"shopSubTotalNetDiscounted": 10,
"recalculatedShopSubTotalGrossDiscounted": 11.9,
"recalculatedShopSubTotalNetDiscounted": 10,
"currency": "EUR",
"orderPositions": 
[
{"shopArticleNo": "100-0001",
"shopArticleNumber": "100-0001",
"shopArticleName": "test_product_1",
"orderPosNo": 1,
"orderPosNumber": 1,
"quantityCanceled": 2,
"quantityOrdered": 10,
"quantityReturned": 2,
"returnDate": "2020-04-16T16:12:24Z",
"shopItemGross": 0,
"shopItemNet": 0,
"shopItemTax": 0,
"shopPosGross": 0,
"shopPosNet": 0,
"shopPosTax": 0,
"shopPosNetDiscounted": 0,
"shopPosGrossDiscounted": 0,
"shopUnit": "string",
"shopItemNetDiscounted": 0,
"shopItemGrossDiscounted": 0,
"quantityRefunded": 0,
"shippingAddress": 
{"firstName": "Bob",
"lastName": "Buyer",
"title": "Dr.",
"companyName": "string",
"street": "Musterstraße",
"houseNumber": "5",
"addressAddition1": "3. OG",
"addressAddition2": "Terasse",
"addressAddition3": "string",
"addressAddition4": "string",
"addressType": "Shipping address",
"postCode": "10178",
"city": "Berlin",
"district": "string",
"country": "Germany",
"email": "b.buyer@bbcompany.de",
"fax": "string",
"mobilePhone": "string",
"phone1": "string",
"phone2": "string",
"isContainerFreightStation": true,
"isDefault": true,
"gender": "male",
"salutation": "Mr.",
"poBox": "string",
"nightShipping": true
}
}
]
}
],
"invoiceAndCreditNotes": 
[
{"type": "creditnote",
"relatedShopOrderNos": "[20180303_123, 20180303_124]",
"relatedShopOrderNumbers": "[20180303_123, 20180303_124]",
"invoiceNo": "2018-000002",
"invoiceNumber": "2018-000002",
"referenceInvoiceNo": "2018-000001",
"referenceInvoiceNumber": "2018-000001",
"invoicingDate": "2020-04-16T16:12:24Z",
"currency": "EUR",
"paymentMethod": "credit card",
"paymentDueDate": "2020-04-16T16:12:24Z",
"invoicePositions": 
[
{"shopOrderNo": 20180303123,
"shopOrderNumber": 20180303123,
"shopArticleNo": "100-0001",
"shopArticleNumber": "100-0001",
"quantity": 10,
"salesItemNet": 1,
"salesItemGross": 1.19,
"chargeNet": 0,
"chargeGross": 0
}
]
}
],
"customerBalances": 
[
{"currency": "EUR",
"openInvoiceAmount": -154.7,
"openInvoiceAmountCalculationDate": "2020-04-16T16:12:24Z",
"bookedCreditSum": 0,
"bookedDebitSum": 0,
"chargedCreditSum": 0,
"chargedDebitSum": 0,
"chargedOpenSum": 0,
"invoicingCreditSum": 0,
"invoicingDebitSum": -154.7,
"negativeBookedOpenSum": 154.7,
"positiveBookedOpenSum": 0
}
]
}