Skip to main content
API docs by Redocly

Article API - Apigee (1.0.0)

Download OpenAPI specification:Download

License: Internal usage only

Article API documentation

Authentication & Authorization

You will need to be identified before calling any endpoints.

In order to be recognized and authorized to access our Sale 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.

Article

Article operation with all operation types

Articles

Get article data

Get articles data filtered by parameters

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

The page number

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

The page size

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

Date from for last update date of data

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

Date to for last update date of data

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

Article reference code of the source

source
string (SourceQueryParam) <= 255 characters
Example: source=GENES

Source application and instance

codes
Array of integers <int32> (CodeListQueryParameter) [ 1 .. 100 ] items [ items <int32 > ]
Example: codes=123,234

List of article code

ean
Array of strings (EanListQueryParameter) [ 1 .. 100 ] items [ items <= 255 characters ]
Example: ean=32974327943,789456

List of ean

Responses

Response samples

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