Skip to main content
API docs by Redocly

Party API - Apigee (1.0.2)

Download OpenAPI specification:Download

License: Internal usage only

Party API documentation

Authentication & Authorization

You will need to be identified before calling any endpoints.

In order to be recognized and authorized to access our Party API, we put in place 2 mechanisms:

  • Authentication mechanism is done with a client id dedicated to you.
    Remember that the client id provided should be shared with care.
    The client id must be inserted in the header of the request in the appropriate field
  • Authorization mechanism is done by a well-known authorization flow for REST Web API: Basic auth flow.

Customers

Customers operation with all operation types

Create retail customer.

This endpoint allows to create or update a retail customer.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
externalRef
required
string <= 255 characters

Party reference code of the source

membership
string <= 255 characters

Membership program of the party

title
string <= 255 characters

The title of the contact (e.g., Mr., Mrs., Ms.)

firstName
string <= 255 characters

The first name of the contact

lastName
string <= 255 characters

The last name of the contact

secondLastName
string <= 255 characters

The second last name of the contact

nationalIdentificationNumber
string <= 255 characters

The national identification number of the contact

email
string <= 255 characters

The email address of the contact

phoneNumber
string <= 255 characters

The phone number of the contact

mobilePhoneNumber
string <= 255 characters

The mobile phone number of the contact

birthDate
string <date>

The birth date of the contact

addressLine1
string <= 255 characters

The first line of the site's address

addressLine2
string <= 255 characters

The second line of the site's address

addressLine3
string <= 255 characters

The third line of the site's address

postalCode
string <= 255 characters

The postal code of the site's address

city
string <= 255 characters

The city of the site's address

subdivision
string <= 255 characters

The subdivision (e.g., state, province) of the site's address

countryCode
required
string <= 255 characters

The country code of the site's address

object

The contact's communication preferences

object

GDPR consent details.

Responses

Request samples

Content type
application/json
{
  • "externalRef": "12345678",
  • "membership": "Michelin",
  • "title": "M",
  • "firstName": "John",
  • "lastName": "DOE",
  • "secondLastName": null,
  • "nationalIdentificationNumber": "12345678E",
  • "email": "mail@email.com",
  • "phoneNumber": "00 001 1111111",
  • "mobilePhoneNumber": null,
  • "birthDate": "1990-10-10",
  • "addressLine1": "Neumarkter Str.",
  • "addressLine2": null,
  • "addressLine3": null,
  • "postalCode": "44666",
  • "city": "City",
  • "subdivision": null,
  • "countryCode": "DE",
  • "communicationChannel": {
    },
  • "gdpr": {
    }
}

Response samples

Content type
application/json
{
  • "code": "10001111"
}

Parties

Parties operation with all operation types

Get parties data

Get parties data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
required
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Example: pageNumber=2

The page number

pageSize
required
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

externalRef
string (ExternalRefQueryParam) <= 255 characters
Example: externalRef=1000045

external ref of the party

source
string (SourceQueryParam) <= 255 characters
Example: source=2024-05-02T10:00:00

source of the party

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "parties": [
    ]
}