Skip to main content
API docs by Redocly

Article API - Apigee (1.1.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.

Articles

Article operation with all operation types

Get article data

Get articles data filtered by parameters

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

The page number

pageSize
integer <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: 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

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

Return the external reference if set to true

Responses

Response samples

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

Create article data

Create article

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

Article reference code of the source

name
string (ArticleName) <= 255 characters

Article name

brand
string (ArticleBrand) <= 255 characters

Article brand

ean
string (ArticleEan) <= 255 characters

Article ean

clearClassCode
string (ArticleClearClassCode) <= 255 characters

Article clear class code

Responses

Request samples

Content type
application/json

Create an article with the given informations

{
  • "externalRef": "12345"
}

Response samples

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

Quick search articles data

Quick search articles data (name and code) filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
value
required
string (ValueQueryParam) [ 1 .. 255 ] characters
Example: value=MIC%20205%20CROSS

The value contained in the article's name

category
required
string (CategoryQueryParam) [ 1 .. 255 ] characters
Example: category=TYRE

The category of the article

type
required
string (TypeQueryParam) [ 1 .. 255 ] characters
Example: type=PRODUCT

The type of the article

limit
integer <int32> (LimitQueryParam) [ 1 .. 1000 ]
Default: 100
Example: limit=2

The limit size

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]